hal_dma.h

Go to the documentation of this file.

/* ----------------------------------------------------------------------------
 * --  _____       ______  _____                                              -
 * -- |_   _|     |  ____|/ ____|                                             -
 * --   | |  _ __ | |__  | (___    Institute of Embedded Systems              -
 * --   | | | '_ \|  __|  \___ \   Zurich University of                       -
 * --  _| |_| | | | |____ ____) |  Applied Sciences                           -
 * -- |_____|_| |_|______|_____/   8401 Winterthur, Switzerland               -
 * ------------------------------------------------------------------------- */
/* Re-definition guard */
#ifndef _HAL_DMA_H
#define _HAL_DMA_H


/* User includes */
#include "reg_stm32f4xx.h"
#include "hal_common.h"


/* -- Type definitions
 * ------------------------------------------------------------------------- */

typedef enum {
    HAL_DMA_STREAM_0 = 0u,
    HAL_DMA_STREAM_1 = 1u,
    HAL_DMA_STREAM_2 = 2u,
    HAL_DMA_STREAM_3 = 3u,
    HAL_DMA_STREAM_4 = 4u,
    HAL_DMA_STREAM_5 = 5u,
    HAL_DMA_STREAM_6 = 6u,
    HAL_DMA_STREAM_7 = 7u
} hal_dma_stream_t;


typedef enum {
    HAL_DMA_CHANNEL_0 = 0u,
    HAL_DMA_CHANNEL_1 = 1u,
    HAL_DMA_CHANNEL_2 = 2u,
    HAL_DMA_CHANNEL_3 = 3u,
    HAL_DMA_CHANNEL_4 = 4u,
    HAL_DMA_CHANNEL_5 = 5u,
    HAL_DMA_CHANNEL_6 = 6u,
    HAL_DMA_CHANNEL_7 = 7u
} hal_dma_channel_t;


typedef enum {
    HAL_DMA_PER_TO_MEM = 0x0,
    HAL_DMA_MEM_TO_PER = 0x1,
    HAL_DMA_MEM_TO_MEM = 0x2
} hal_dma_dir_t;


typedef enum {
    HAL_DMA_SIZE_8B = 0x0,
    HAL_DMA_SIZE_16B = 0x1,
    HAL_DMA_SIZE_32B = 0x2
} hal_dma_size_t;


typedef struct {
    hal_dma_channel_t channel;  
    hal_dma_dir_t direction;    
    uint32_t source;            
    uint32_t destination;       
    hal_dma_size_t size;        
    uint8_t nr_transactions;    
    hal_bool_t continous;       
} hal_dma_init_t;


/* -- Public function declarations
 * ------------------------------------------------------------------------- */

void hal_dma_reset(reg_dma_t *dma, hal_dma_stream_t stream)
__attribute__((deprecated("Please use DMAx_RESET().")));

void hal_dma_init_base(reg_dma_t *dma, 
                       hal_dma_stream_t stream, 
                       hal_dma_init_t init);

void hal_dma_start(reg_dma_t *dma, hal_dma_stream_t stream);

void hal_dma_stop(reg_dma_t *dma, hal_dma_stream_t stream);


#endif