271 lines
9.6 KiB
C
271 lines
9.6 KiB
C
|
/******************************************************************************
|
||
|
* The MIT License
|
||
|
*
|
||
|
* Copyright (c) 2010 Michael Hope.
|
||
|
*
|
||
|
* Permission is hereby granted, free of charge, to any person
|
||
|
* obtaining a copy of this software and associated documentation
|
||
|
* files (the "Software"), to deal in the Software without
|
||
|
* restriction, including without limitation the rights to use, copy,
|
||
|
* modify, merge, publish, distribute, sublicense, and/or sell copies
|
||
|
* of the Software, and to permit persons to whom the Software is
|
||
|
* furnished to do so, subject to the following conditions:
|
||
|
*
|
||
|
* The above copyright notice and this permission notice shall be
|
||
|
* included in all copies or substantial portions of the Software.
|
||
|
*
|
||
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
||
|
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
||
|
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
||
|
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
|
||
|
* BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
|
||
|
* ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
||
|
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||
|
* SOFTWARE.
|
||
|
*****************************************************************************/
|
||
|
|
||
|
/**
|
||
|
* @file dma.h
|
||
|
*
|
||
|
* @author Marti Bolivar <mbolivar@leaflabs.com>;
|
||
|
* Original implementation by Michael Hope
|
||
|
*
|
||
|
* @brief Direct Memory Access peripheral support
|
||
|
*/
|
||
|
|
||
|
/*
|
||
|
* See /notes/dma.txt for more information.
|
||
|
*/
|
||
|
|
||
|
#ifndef _DMA_H_
|
||
|
#define _DMA_H_
|
||
|
|
||
|
#include "libmaple_types.h"
|
||
|
#include "rcc.h"
|
||
|
#include "nvic.h"
|
||
|
|
||
|
#ifdef __cplusplus
|
||
|
extern "C"{
|
||
|
#endif
|
||
|
|
||
|
/*
|
||
|
* Register maps
|
||
|
*/
|
||
|
|
||
|
/**
|
||
|
* @brief DMA stream type.
|
||
|
*
|
||
|
*/
|
||
|
typedef struct dma_stream_t {
|
||
|
__io uint32 CR; /**< Stream configuration register */
|
||
|
__io uint32 NDTR; /**< Stream number of data register */
|
||
|
__io uint32 PAR; /**< Stream peripheral address register */
|
||
|
__io uint32 M0AR; /**< Stream memory address register 0 */
|
||
|
__io uint32 M1AR; /**< Stream memory address register 1 */
|
||
|
__io uint32 FCR; /**< Stream FIFO configuration register */
|
||
|
} dma_stream_t;
|
||
|
/**
|
||
|
* @brief DMA register map type.
|
||
|
*
|
||
|
*/
|
||
|
typedef struct dma_reg_map {
|
||
|
__io uint32 LISR; /**< Low interrupt status register */
|
||
|
__io uint32 HISR; /**< High interrupt status register */
|
||
|
__io uint32 LIFCR; /**< Low interrupt flag clear register */
|
||
|
__io uint32 HIFCR; /**< High interrupt flag clear register */
|
||
|
dma_stream_t STREAM[8];
|
||
|
} dma_reg_map;
|
||
|
|
||
|
/** DMA controller register map base pointers */
|
||
|
#define DMA1_BASE ((struct dma_reg_map*)0x40026000)
|
||
|
#define DMA2_BASE ((struct dma_reg_map*)0x40026400)
|
||
|
|
||
|
/*
|
||
|
* Register bit definitions
|
||
|
*/
|
||
|
|
||
|
/* Channel configuration register */
|
||
|
|
||
|
#define DMA_CR_CH0 (0x0 << 25)
|
||
|
#define DMA_CR_CH1 (0x1 << 25)
|
||
|
#define DMA_CR_CH2 (0x2 << 25)
|
||
|
#define DMA_CR_CH3 (0x3 << 25)
|
||
|
#define DMA_CR_CH4 (0x4 << 25)
|
||
|
#define DMA_CR_CH5 (0x5 << 25)
|
||
|
#define DMA_CR_CH6 (0x6 << 25)
|
||
|
#define DMA_CR_CH7 (0x7 << 25)
|
||
|
#define DMA_CR_MBURST0 (0x0 << 23)
|
||
|
#define DMA_CR_MBURST4 (0x1 << 23)
|
||
|
#define DMA_CR_MBURST8 (0x2 << 23)
|
||
|
#define DMA_CR_MBURST16 (0x3 << 23)
|
||
|
#define DMA_CR_PBURST0 (0x0 << 21)
|
||
|
#define DMA_CR_PBURST4 (0x1 << 21)
|
||
|
#define DMA_CR_PBURST8 (0x2 << 21)
|
||
|
#define DMA_CR_PBURST16 (0x3 << 21)
|
||
|
#define DMA_CR_CT0 (0x0 << 19)
|
||
|
#define DMA_CR_CT1 (0x1 << 19)
|
||
|
#define DMA_CR_DBM (0x1 << 18)
|
||
|
|
||
|
#define DMA_CR_PL_LOW (0x0 << 16)
|
||
|
#define DMA_CR_PL_MEDIUM (0x1 << 16)
|
||
|
#define DMA_CR_PL_HIGH (0x2 << 16)
|
||
|
#define DMA_CR_PL_VERY_HIGH (0x3 << 16)
|
||
|
#define DMA_CR_PL_MASK (0x3 << 16)
|
||
|
|
||
|
#define DMA_CR_PINCOS (0x1 << 15)
|
||
|
|
||
|
#define DMA_CR_MSIZE_8BITS (0x0 << 13)
|
||
|
#define DMA_CR_MSIZE_16BITS (0x1 << 13)
|
||
|
#define DMA_CR_MSIZE_32BITS (0x2 << 13)
|
||
|
|
||
|
#define DMA_CR_PSIZE_8BITS (0x0 << 11)
|
||
|
#define DMA_CR_PSIZE_16BITS (0x1 << 11)
|
||
|
#define DMA_CR_PSIZE_32BITS (0x2 << 11)
|
||
|
|
||
|
#define DMA_CR_MINC (0x1 << 10)
|
||
|
#define DMA_CR_PINC (0x1 << 9)
|
||
|
#define DMA_CR_CIRC (0x1 << 8)
|
||
|
#define DMA_CR_DIR_P2M (0x0 << 6)
|
||
|
#define DMA_CR_DIR_M2P (0x1 << 6)
|
||
|
#define DMA_CR_DIR_M2M (0x2 << 6)
|
||
|
|
||
|
#define DMA_CR_PFCTRL (0x1 << 5)
|
||
|
#define DMA_CR_TCIE (0x1 << 4)
|
||
|
#define DMA_CR_HTIE (0x1 << 3)
|
||
|
#define DMA_CR_TEIE (0x1 << 2)
|
||
|
#define DMA_CR_DMEIE (0x1 << 1)
|
||
|
#define DMA_CR_EN (0x1)
|
||
|
|
||
|
/*
|
||
|
* Devices
|
||
|
*/
|
||
|
|
||
|
/** Encapsulates state related to a DMA channel interrupt. */
|
||
|
typedef struct dma_handler_config {
|
||
|
void (*handler)(void); /**< User-specified channel interrupt
|
||
|
handler */
|
||
|
nvic_irq_num irq_line; /**< Channel's NVIC interrupt number */
|
||
|
} dma_handler_config;
|
||
|
|
||
|
/** DMA device type */
|
||
|
typedef struct dma_dev {
|
||
|
dma_reg_map *regs; /**< Register map */
|
||
|
rcc_clk_id clk_id; /**< Clock ID */
|
||
|
dma_handler_config handlers[]; /**<
|
||
|
* @brief IRQ handlers and NVIC numbers.
|
||
|
*
|
||
|
* @see dma_attach_interrupt()
|
||
|
* @see dma_detach_interrupt()
|
||
|
*/
|
||
|
} dma_dev;
|
||
|
|
||
|
extern dma_dev *DMA1;
|
||
|
extern dma_dev *DMA2;
|
||
|
|
||
|
/*
|
||
|
* Convenience functions
|
||
|
*/
|
||
|
|
||
|
void dma_init(dma_dev *dev);
|
||
|
|
||
|
/** Flags for DMA transfer configuration. */
|
||
|
typedef enum dma_mode_flags {
|
||
|
DMA_MEM_2_MEM = 1 << 14, /**< Memory to memory mode */
|
||
|
DMA_MINC_MODE = 1 << 7, /**< Auto-increment memory address */
|
||
|
DMA_PINC_MODE = 1 << 6, /**< Auto-increment peripheral address */
|
||
|
DMA_CIRC_MODE = 1 << 5, /**< Circular mode */
|
||
|
DMA_FROM_MEM = 1 << 4, /**< Read from memory to peripheral */
|
||
|
DMA_TRNS_ERR = 1 << 3, /**< Interrupt on transfer error */
|
||
|
DMA_HALF_TRNS = 1 << 2, /**< Interrupt on half-transfer */
|
||
|
DMA_TRNS_CMPLT = 1 << 1 /**< Interrupt on transfer completion */
|
||
|
} dma_mode_flags;
|
||
|
|
||
|
/** Source and destination transfer sizes. */
|
||
|
typedef enum dma_xfer_size {
|
||
|
DMA_SIZE_8BITS = 0, /**< 8-bit transfers */
|
||
|
DMA_SIZE_16BITS = 1, /**< 16-bit transfers */
|
||
|
DMA_SIZE_32BITS = 2 /**< 32-bit transfers */
|
||
|
} dma_xfer_size;
|
||
|
|
||
|
/** DMA channel */
|
||
|
typedef enum dma_stream {
|
||
|
DMA_STREAM0 = 0, /**< Stream 0 */
|
||
|
DMA_STREAM1 = 1, /**< Stream 1 */
|
||
|
DMA_STREAM2 = 2, /**< Stream 2 */
|
||
|
DMA_STREAM3 = 3, /**< Stream 3 */
|
||
|
DMA_STREAM4 = 4, /**< Stream 4 */
|
||
|
DMA_STREAM5 = 5, /**< Stream 5 */
|
||
|
DMA_STREAM6 = 6, /**< Stream 6 */
|
||
|
DMA_STREAM7 = 7, /**< Stream 7 */
|
||
|
} dma_stream;
|
||
|
|
||
|
static inline void dma_setup_transfer(dma_dev *dev,
|
||
|
dma_stream stream,
|
||
|
__io void *peripheral_address,
|
||
|
__io void *memory_address0,
|
||
|
__io void *memory_address1,
|
||
|
uint32 flags,
|
||
|
uint32 fifo_flags) {
|
||
|
dev->regs->STREAM[stream].CR &= ~DMA_CR_EN; // disable
|
||
|
dev->regs->STREAM[stream].PAR = (uint32)peripheral_address;
|
||
|
dev->regs->STREAM[stream].M0AR = (uint32)memory_address0;
|
||
|
dev->regs->STREAM[stream].M1AR = (uint32)memory_address1;
|
||
|
dev->regs->STREAM[stream].FCR = fifo_flags & 0x87; // mask out reserved bits
|
||
|
dev->regs->STREAM[stream].CR = flags & 0x0feffffe; // mask out reserved and enable
|
||
|
}
|
||
|
|
||
|
static inline void dma_set_num_transfers(dma_dev *dev,
|
||
|
dma_stream stream,
|
||
|
uint16 num_transfers) {
|
||
|
dev->regs->STREAM[stream].NDTR = num_transfers;
|
||
|
}
|
||
|
|
||
|
void dma_attach_interrupt(dma_dev *dev,
|
||
|
dma_stream stream,
|
||
|
void (*handler)(void));
|
||
|
|
||
|
void dma_detach_interrupt(dma_dev *dev, dma_stream stream);
|
||
|
|
||
|
static inline void dma_enable(dma_dev *dev, dma_stream stream) {
|
||
|
dev->regs->STREAM[stream].CR |= DMA_CR_EN;
|
||
|
}
|
||
|
|
||
|
static inline void dma_disable(dma_dev *dev, dma_stream stream) {
|
||
|
dev->regs->STREAM[stream].CR &= ~DMA_CR_EN;
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* @brief Check if a DMA stream is enabled
|
||
|
* @param dev DMA device
|
||
|
* @param stream Stream whose enabled bit to check.
|
||
|
*/
|
||
|
static inline uint8 dma_is_stream_enabled(dma_dev *dev, dma_stream stream) {
|
||
|
return (uint8)(dev->regs->STREAM[stream].CR & DMA_CR_EN);
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* @brief Get the ISR status bits for a DMA stream.
|
||
|
*
|
||
|
* The bits are returned right-aligned, in the following order:
|
||
|
* transfer error flag, half-transfer flag, transfer complete flag,
|
||
|
* global interrupt flag.
|
||
|
*
|
||
|
* @param dev DMA device
|
||
|
* @param stream Stream whose ISR bits to return.
|
||
|
*/
|
||
|
uint8 dma_get_isr_bits(dma_dev *dev, dma_stream stream);
|
||
|
|
||
|
/**
|
||
|
* @brief Clear the ISR status bits for a given DMA stream.
|
||
|
*
|
||
|
* @param dev DMA device
|
||
|
* @param stream Stream whose ISR bits to clear.
|
||
|
*/
|
||
|
void dma_clear_isr_bits(dma_dev *dev, dma_stream stream);
|
||
|
|
||
|
#ifdef __cplusplus
|
||
|
} // extern "C"
|
||
|
#endif
|
||
|
|
||
|
#endif
|