cpu_dma.h

Go to the documentation of this file.

/*
 * Copyright (C) 2016 Freie Universität Berlin
 *               2017 OTA keys S.A.
 *
 * This file is subject to the terms and conditions of the GNU Lesser
 * General Public License v2.1. See the file LICENSE in the top level
 * directory for more details.
 */
 
#ifndef PERIPH_CPU_DMA_H
#define PERIPH_CPU_DMA_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct {
    int stream;
} dma_conf_t;
 
typedef unsigned dma_t;
 
typedef enum {
    DMA_PERIPH_TO_MEM = 0,     
    DMA_MEM_TO_PERIPH = 1,     
    DMA_MEM_TO_MEM = 2,        
} dma_mode_t;
 
typedef enum {
    DMA_BURST_SINGLE = 0,   
    DMA_BURST_INCR4 = 1,    
    DMA_BURST_INCR8 = 2,    
    DMA_BURST_INCR16 = 3,   
} dma_burst_t;
 
typedef enum {
    DMA_FIFO_FULL_1_4 = 0,  
    DMA_FIFO_FULL_1_2 = 1,  
    DMA_FIFO_FULL_3_4 = 2,  
    DMA_FIFO_FULL = 3,      
} dma_fifo_thresh_t;
 
#define DMA_CHAN_CONFIG_UNSUPPORTED  (UINT8_MAX)
 
#define DMA_INC_SRC_ADDR  (0x04)    
#define DMA_INC_DST_ADDR  (0x08)    
#define DMA_INC_BOTH_ADDR (DMA_INC_SRC_ADDR | DMA_INC_DST_ADDR) 
#define DMA_DATA_WIDTH_BYTE      (0x00) 
#define DMA_DATA_WIDTH_HALF_WORD (0x01) 
#define DMA_DATA_WIDTH_WORD      (0x02) 
#ifdef MODULE_PERIPH_DMA
#define DMA_STREAM_UNDEF (UINT_MAX)
 
void dma_init(void);
 
int dma_transfer(dma_t dma, int chan, const volatile void *src, volatile void *dst, size_t len,
                 dma_mode_t mode, uint8_t flags);
 
void dma_acquire(dma_t dma);
 
void dma_release(dma_t dma);
 
void dma_start(dma_t dma);
 
uint16_t dma_suspend(dma_t dma);
 
void dma_resume(dma_t dma, uint16_t remaining);
 
void dma_stop(dma_t dma);
 
void dma_wait(dma_t dma);
 
int dma_configure(dma_t dma, int chan, const volatile void *src, volatile void *dst, size_t len,
                  dma_mode_t mode, uint8_t flags);
 
void dma_setup(dma_t dma, int chan, void *periph_addr, dma_mode_t mode,
               uint8_t width, bool inc_periph);
 
void dma_setup_ext(dma_t dma, dma_burst_t pburst, dma_burst_t mburst,
                   bool fifo, dma_fifo_thresh_t thresh, bool pfctrl);
 
void dma_prepare(dma_t dma, void *mem, size_t len, bool incr_mem);
 
#endif /* MODULE_PERIPH_DMA */
 
#ifdef __cplusplus
}
#endif
 
#endif /* PERIPH_CPU_DMA_H */