dma.h

Go to the documentation of this file.

 
#ifndef PHAL_G4_DMA_H
#define PHAL_G4_DMA_H
 
#include <stdint.h>
 
#include "stm32g474xx.h"
 
#include "common/phal_G4/dma/dma_wiring.h"
 
typedef enum {
    DMA_PRIORITY_LOW       = 0,
    DMA_PRIORITY_MEDIUM    = 1,
    DMA_PRIORITY_HIGH      = 2,
    DMA_PRIORITY_VERY_HIGH = 3,
} PHAL_DMA_Priority_t;
 
typedef enum {
    DMA_MODE_NORMAL   = 0, 
    DMA_MODE_CIRCULAR = 1, 
    DMA_MODE_MEM2MEM  = 2, 
} PHAL_DMA_Mode_t;
 
typedef struct {
    uint32_t mem_addr;         
    uint16_t tx_size;          
    PHAL_DMA_Priority_t priority;
    PHAL_DMA_Mode_t mode;
    bool mem_inc;              
    bool tx_isr_en;            
} PHAL_DMA_Params_t;
 
 
typedef void (*PHAL_DMA_IRQCallbackFn_t)(void *ctx);
 
typedef struct {
    PHAL_DMA_IRQCallbackFn_t irq_fn; 
    void *ctx;                       
} PHAL_DMA_Callback_t;
 
typedef struct {
    const PHAL_DMA_Wiring_t *wiring;
    PHAL_DMA_Params_t params;
    DMA_Channel_TypeDef *channel; 
    PHAL_DMA_Callback_t callback; 
} PHAL_DMA_Handle_t;
 
 
bool PHAL_DMA_init(PHAL_DMA_Handle_t *handle);
 
bool PHAL_DMA_initWithCallback(PHAL_DMA_Handle_t *handle, PHAL_DMA_IRQCallbackFn_t irq_fn, void *ctx);
 
void PHAL_DMA_deinit(PHAL_DMA_Handle_t *handle);
 
void PHAL_DMA_start(PHAL_DMA_Handle_t *handle);
 
void PHAL_DMA_stop(PHAL_DMA_Handle_t *handle);
 
void PHAL_DMA_restart(PHAL_DMA_Handle_t *handle);
 
bool PHAL_DMA_setMemAddress(PHAL_DMA_Handle_t *handle, uint32_t address);
 
bool PHAL_DMA_setLength(PHAL_DMA_Handle_t *handle, uint16_t length);
 
void PHAL_DMA_setMemInc(PHAL_DMA_Handle_t *handle, bool mem_inc);
 
uint16_t PHAL_DMA_getRemaining(PHAL_DMA_Handle_t *handle);
 
bool PHAL_DMA_isBusy(const PHAL_DMA_Handle_t *handle);
 
bool PHAL_DMA_isComplete(const PHAL_DMA_Handle_t *handle);
 
bool PHAL_DMA_isError(const PHAL_DMA_Handle_t *handle);
 
void PHAL_DMA_clearFlags(PHAL_DMA_Handle_t *handle);
 
DMA_TypeDef *PHAL_DMA_getPeriph(PHAL_DMA_Handle_t *handle);
 
uint8_t PHAL_DMA_getChannelIdx(PHAL_DMA_Handle_t *handle);
 
 
#endif // PHAL_G4_DMA_H