pinebuds/platform/hal/hal_dma.h
2022-08-15 17:20:27 +08:00

293 lines
11 KiB
C

/***************************************************************************
*
* Copyright 2015-2019 BES.
* All rights reserved. All unpublished rights reserved.
*
* No part of this work may be used or reproduced in any form or by any
* means, or stored in a database or retrieval system, without prior written
* permission of BES.
*
* Use of this work is governed by a license granted by BES.
* This work contains confidential and proprietary information of
* BES. which is protected by copyright, trade secret,
* trademark and other intellectual property rights.
*
****************************************************************************/
#ifndef __HAL_DMA_H__
#define __HAL_DMA_H__
#ifdef __cplusplus
extern "C" {
#endif
#include "stdint.h"
#include "stdbool.h"
#define HAL_DMA_CHAN_NONE 0xFF
#define HAL_DMA_MAX_DESC_XFER_SIZE 0xFFF
enum HAL_DMA_RET_T {
HAL_DMA_OK,
HAL_DMA_ERR,
};
enum HAL_DMA_GET_CHAN_T {
HAL_DMA_HIGH_PRIO,
HAL_DMA_LOW_PRIO,
HAL_DMA_LOW_PRIO_ONLY
};
// DMA Type of DMA controller
enum HAL_DMA_FLOW_CONTROL_T {
HAL_DMA_FLOW_M2M_DMA = 0, /* Memory to memory - DMA control */
HAL_DMA_FLOW_M2P_DMA = 1, /* Memory to peripheral - DMA control */
HAL_DMA_FLOW_P2M_DMA = 2, /* Peripheral to memory - DMA control */
HAL_DMA_FLOW_P2P_DMA = 3, /* Source peripheral to destination peripheral - DMA control */
HAL_DMA_FLOW_P2P_DSTPERIPH = 4, /* Source peripheral to destination peripheral - destination peripheral control */
HAL_DMA_FLOW_M2P_PERIPH = 5, /* Memory to peripheral - peripheral control */
HAL_DMA_FLOW_P2M_PERIPH = 6, /* Peripheral to memory - peripheral control */
HAL_DMA_FLOW_P2P_SRCPERIPH = 7, /* Source peripheral to destination peripheral - source peripheral control */
HAL_DMA_FLOW_FLAG_SI = 0x40,
HAL_DMA_FLOW_FLAG_DI = 0x80,
HAL_DMA_FLOW_FLAG_MASK = (HAL_DMA_FLOW_FLAG_SI | HAL_DMA_FLOW_FLAG_DI),
HAL_DMA_FLOW_M2P_DI_DMA = HAL_DMA_FLOW_M2P_DMA | HAL_DMA_FLOW_FLAG_DI,
HAL_DMA_FLOW_P2M_SI_DMA = HAL_DMA_FLOW_P2M_DMA | HAL_DMA_FLOW_FLAG_SI,
HAL_DMA_FLOW_P2P_DI_DMA = HAL_DMA_FLOW_P2P_DMA | HAL_DMA_FLOW_FLAG_DI,
HAL_DMA_FLOW_P2P_SI_DMA = HAL_DMA_FLOW_P2P_DMA | HAL_DMA_FLOW_FLAG_SI,
};
// DMA Burst size in Source and Destination definitions
enum HAL_DMA_BSIZE_T {
HAL_DMA_BSIZE_1 = 0, /* Burst size = 1 */
HAL_DMA_BSIZE_4 = 1, /* Burst size = 4 */
HAL_DMA_BSIZE_8 = 2, /* Burst size = 8 */
HAL_DMA_BSIZE_16 = 3, /* Burst size = 16 */
HAL_DMA_BSIZE_32 = 4, /* Burst size = 32 */
HAL_DMA_BSIZE_64 = 5, /* Burst size = 64 */
HAL_DMA_BSIZE_128 = 6, /* Burst size = 128 */
HAL_DMA_BSIZE_256 = 7, /* Burst size = 256 */
};
// Width in Source transfer width and Destination transfer width definitions
enum HAL_DMA_WDITH_T {
HAL_DMA_WIDTH_BYTE = 0, /* Width = 1 byte */
HAL_DMA_WIDTH_HALFWORD = 1, /* Width = 2 bytes */
HAL_DMA_WIDTH_WORD = 2, /* Width = 4 bytes */
};
enum HAL_DMA_PERIPH_T {
HAL_DMA_PERIPH_NULL = 0,
HAL_GPDMA_MEM = 1,
HAL_AUDMA_MEM = 2,
HAL_GPDMA_SDIO = 10,
HAL_GPDMA_SDMMC = 11,
HAL_GPDMA_I2C0_RX = 12,
HAL_GPDMA_I2C0_TX = 13,
HAL_GPDMA_SPI_RX = 14,
HAL_GPDMA_SPI_TX = 15,
HAL_GPDMA_SPILCD_RX = 16,
HAL_GPDMA_SPILCD_TX = 17,
HAL_GPDMA_UART0_RX = 18,
HAL_GPDMA_UART0_TX = 19,
HAL_GPDMA_UART1_RX = 20,
HAL_GPDMA_UART1_TX = 21,
HAL_GPDMA_ISPI_RX = 22,
HAL_GPDMA_ISPI_TX = 23,
HAL_GPDMA_UART2_RX = 24,
HAL_GPDMA_UART2_TX = 25,
HAL_GPDMA_FLASH_RX = 26,
HAL_GPDMA_FLASH_TX = 27,
HAL_GPDMA_I2C1_RX = 28,
HAL_GPDMA_I2C1_TX = 29,
HAL_GPDMA_I2C2_RX = 30,
HAL_GPDMA_I2C2_TX = 31,
HAL_GPDMA_I2C3_RX = 32,
HAL_GPDMA_I2C3_TX = 33,
HAL_AUDMA_CODEC_RX = 50,
HAL_AUDMA_CODEC_TX = 51,
HAL_AUDMA_BTPCM_RX = 52,
HAL_AUDMA_BTPCM_TX = 53,
HAL_AUDMA_I2S0_RX = 54,
HAL_AUDMA_I2S0_TX = 55,
HAL_AUDMA_DPD_RX = 56,
HAL_AUDMA_DPD_TX = 57,
HAL_AUDMA_SPDIF0_RX = 58,
HAL_AUDMA_SPDIF0_TX = 59,
HAL_AUDMA_SPDIF1_RX = 60,
HAL_AUDMA_SPDIF1_TX = 61,
HAL_AUDMA_DSD_RX = 62,
HAL_AUDMA_DSD_TX = 63,
HAL_AUDMA_MC_RX = 64,
HAL_AUDMA_FFT_RX = 65,
HAL_AUDMA_FFT_TX = 66,
HAL_AUDMA_FIR_RX = 67,
HAL_AUDMA_FIR_TX = 68,
HAL_AUDMA_IIR_RX = 69,
HAL_AUDMA_IIR_TX = 70,
HAL_AUDMA_BTDUMP = 71,
HAL_AUDMA_I2S1_RX = 72,
HAL_AUDMA_I2S1_TX = 73,
HAL_AUDMA_FM_RX = 74,
HAL_AUDMA_FMDUMP0 = 75,
HAL_AUDMA_FMDUMP1 = 76,
HAL_AUDMA_CODEC_TX2 = 77,
HAL_DMA_PERIPH_QTY,
};
struct HAL_DMA_DESC_T;
typedef void (*HAL_DMA_IRQ_HANDLER_T)(uint8_t chan, uint32_t remain_tsize, uint32_t error, struct HAL_DMA_DESC_T *lli);
typedef void (*HAL_DMA_START_CALLBACK_T)(uint8_t chan);
typedef void (*HAL_DMA_DELAY_FUNC)(uint32_t ms);
// DMA structure using for DMA configuration
struct HAL_DMA_CH_CFG_T {
uint8_t ch; /* DMA channel number */
uint8_t try_burst;
uint16_t src_tsize; /* Length/Size of transfer */
enum HAL_DMA_WDITH_T src_width;
enum HAL_DMA_WDITH_T dst_width;
enum HAL_DMA_BSIZE_T src_bsize;
enum HAL_DMA_BSIZE_T dst_bsize;
enum HAL_DMA_FLOW_CONTROL_T type; /* Transfer Type */
enum HAL_DMA_PERIPH_T src_periph;
enum HAL_DMA_PERIPH_T dst_periph;
uint32_t src; /* Physical Source Address */
uint32_t dst; /* Physical Destination Address */
HAL_DMA_IRQ_HANDLER_T handler;
HAL_DMA_START_CALLBACK_T start_cb;
};
// Transfer Descriptor structure typedef
struct HAL_DMA_DESC_T {
uint32_t src; /* Source address */
uint32_t dst; /* Destination address */
uint32_t lli; /* Pointer to next descriptor structure */
uint32_t ctrl; /* Control word that has transfer size, type etc. */
};
// DMA 2D configuration structure
struct HAL_DMA_2D_CFG_T {
int16_t xmodify;
uint16_t xcount;
int16_t ymodify;
uint16_t ycount;
};
struct HAL_DMA_BURST_ADDR_INC_T {
bool src_inc_en;
bool dst_inc_en;
int16_t src_inc_val;
int16_t dst_inc_val;
};
//=============================================================
void hal_dma_open(void);
void hal_dma_close(void);
void hal_dma_sleep(void);
void hal_dma_wakeup(void);
bool hal_dma_chan_busy(uint8_t ch);
uint8_t hal_dma_get_chan(enum HAL_DMA_PERIPH_T periph, enum HAL_DMA_GET_CHAN_T policy);
void hal_dma_free_chan(uint8_t ch);
uint32_t hal_dma_cancel(uint8_t ch);
uint32_t hal_dma_stop(uint8_t ch);
enum HAL_DMA_RET_T hal_dma_init_desc(struct HAL_DMA_DESC_T *desc,
const struct HAL_DMA_CH_CFG_T *cfg,
const struct HAL_DMA_DESC_T *next,
int tc_irq);
enum HAL_DMA_RET_T hal_dma_sg_start(const struct HAL_DMA_DESC_T *desc,
const struct HAL_DMA_CH_CFG_T *cfg);
enum HAL_DMA_RET_T hal_dma_sg_2d_start(const struct HAL_DMA_DESC_T *desc,
const struct HAL_DMA_CH_CFG_T *cfg,
const struct HAL_DMA_2D_CFG_T *src_2d,
const struct HAL_DMA_2D_CFG_T *dst_2d);
enum HAL_DMA_RET_T hal_dma_start(const struct HAL_DMA_CH_CFG_T *cfg);
uint32_t hal_dma_get_cur_src_addr(uint8_t ch);
uint32_t hal_dma_get_cur_dst_addr(uint8_t ch);
void hal_dma_get_cur_src_remain_and_addr(uint8_t ch, uint32_t *remain, uint32_t *src);
uint32_t hal_dma_get_sg_remain_size(uint8_t ch);
enum HAL_DMA_RET_T hal_dma_irq_run_chan(uint8_t ch);
bool hal_dma_busy(void);
HAL_DMA_DELAY_FUNC hal_dma_set_delay_func(HAL_DMA_DELAY_FUNC new_func);
void hal_dma_remap_periph(enum HAL_DMA_PERIPH_T periph, int enable);
void hal_dma_tc_irq_enable(uint8_t ch);
void hal_dma_tc_irq_disable(uint8_t ch);
void hal_dma_set_burst_addr_inc(uint8_t ch, const struct HAL_DMA_BURST_ADDR_INC_T *inc);
void hal_dma_clear_burst_addr_inc(uint8_t ch);
void hal_dma_set_desc_burst_addr_inc(struct HAL_DMA_DESC_T *desc, const struct HAL_DMA_BURST_ADDR_INC_T *inc);
void hal_dma_clear_desc_burst_addr_inc(struct HAL_DMA_DESC_T *desc);
//=============================================================
#define hal_audma_open hal_dma_open
#define hal_audma_close hal_dma_close
#define hal_audma_chan_busy hal_dma_chan_busy
#define hal_audma_get_chan hal_dma_get_chan
#define hal_audma_free_chan hal_dma_free_chan
#define hal_audma_cancel hal_dma_cancel
#define hal_audma_stop hal_dma_stop
#define hal_audma_init_desc hal_dma_init_desc
#define hal_audma_sg_start hal_dma_sg_start
#define hal_audma_start hal_dma_start
#define hal_audma_get_cur_src_addr hal_dma_get_cur_src_addr
#define hal_audma_get_cur_dst_addr hal_dma_get_cur_dst_addr
#define hal_audma_get_sg_remain_size hal_dma_get_sg_remain_size
#define hal_audma_irq_run_chan hal_dma_irq_run_chan
#define hal_gpdma_open hal_dma_open
#define hal_gpdma_close hal_dma_close
#define hal_gpdma_chan_busy hal_dma_chan_busy
#define hal_gpdma_get_chan hal_dma_get_chan
#define hal_gpdma_free_chan hal_dma_free_chan
#define hal_gpdma_cancel hal_dma_cancel
#define hal_gpdma_stop hal_dma_stop
#define hal_gpdma_init_desc hal_dma_init_desc
#define hal_gpdma_sg_start hal_dma_sg_start
#define hal_gpdma_start hal_dma_start
#define hal_gpdma_get_cur_src_addr hal_dma_get_cur_src_addr
#define hal_gpdma_get_cur_dst_addr hal_dma_get_cur_dst_addr
#define hal_gpdma_get_sg_remain_size hal_dma_get_sg_remain_size
#define hal_gpdma_irq_run_chan hal_dma_irq_run_chan
//=============================================================
#ifdef __cplusplus
}
#endif
#endif