mirror of
https://github.com/espressif/esp-idf.git
synced 2026-10-01 18:50:34 +03:00
feat(dma): graduate the dma driver into a single component
This commit is contained in:
@@ -1,98 +0,0 @@
|
||||
/*
|
||||
* SPDX-FileCopyrightText: 2020-2022 Espressif Systems (Shanghai) CO LTD
|
||||
*
|
||||
* SPDX-License-Identifier: Apache-2.0
|
||||
*/
|
||||
|
||||
/*******************************************************************************
|
||||
* NOTICE
|
||||
* The HAL is not public api, don't use in application code.
|
||||
* See readme.md in soc/README.md
|
||||
******************************************************************************/
|
||||
|
||||
// CP DMA HAL usages:
|
||||
// 1. Initialize HAL layer by cp_dma_hal_init, pass in the allocated descriptors for TX and RX
|
||||
// 2. Enable DMA and interrupt by cp_dma_hal_start
|
||||
// 3. Prepare descriptors used for TX and RX
|
||||
// 4. Restart the DMA engine in case it's not in working
|
||||
|
||||
#pragma once
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
#include <stddef.h>
|
||||
#include <stdbool.h>
|
||||
#include "esp_attr.h"
|
||||
#include "hal/dma_types.h"
|
||||
#include "soc/cp_dma_struct.h"
|
||||
|
||||
/**
|
||||
* @brief HAL context
|
||||
*
|
||||
*/
|
||||
typedef struct {
|
||||
cp_dma_dev_t *dev;
|
||||
} cp_dma_hal_context_t;
|
||||
|
||||
typedef struct {
|
||||
} cp_dma_hal_config_t;
|
||||
|
||||
/**
|
||||
* @brief Initialize HAL layer context
|
||||
*
|
||||
* @param hal HAL layer context, whose memroy should be allocated at driver layer
|
||||
* @param config configuration for the HAL layer
|
||||
*/
|
||||
void cp_dma_hal_init(cp_dma_hal_context_t *hal, const cp_dma_hal_config_t *config);
|
||||
|
||||
/**
|
||||
* @brief Deinitialize HAL layer context
|
||||
*/
|
||||
void cp_dma_hal_deinit(cp_dma_hal_context_t *hal);
|
||||
|
||||
/**
|
||||
* @brief Set descriptor base address
|
||||
*/
|
||||
void cp_dma_hal_set_desc_base_addr(cp_dma_hal_context_t *hal, intptr_t outlink_base, intptr_t inlink_base);
|
||||
|
||||
/**
|
||||
* @brief Start mem2mem DMA state machine
|
||||
*/
|
||||
void cp_dma_hal_start(cp_dma_hal_context_t *hal);
|
||||
|
||||
/**
|
||||
* @brief Stop mem2mem DMA state machine
|
||||
*/
|
||||
void cp_dma_hal_stop(cp_dma_hal_context_t *hal);
|
||||
|
||||
/**
|
||||
* @brief Get interrupt status word
|
||||
*
|
||||
* @return uint32_t Interrupt status
|
||||
*/
|
||||
uint32_t cp_dma_hal_get_intr_status(cp_dma_hal_context_t *hal) IRAM_ATTR;
|
||||
|
||||
/**
|
||||
* @brief Clear interrupt mask
|
||||
*
|
||||
* @param mask interrupt mask
|
||||
*/
|
||||
void cp_dma_hal_clear_intr_status(cp_dma_hal_context_t *hal, uint32_t mask) IRAM_ATTR;
|
||||
|
||||
/**@{*/
|
||||
/**
|
||||
* @brief Give the owner of descriptors between [start_desc, end_desc] to DMA, and restart DMA HW engine
|
||||
*
|
||||
* @param hal HAL layer context
|
||||
* @param start_desc The first descriptor that carries one transaction
|
||||
* @param end_desc The last descriptor that carries one transaction
|
||||
*/
|
||||
void cp_dma_hal_restart_tx(cp_dma_hal_context_t *hal);
|
||||
void cp_dma_hal_restart_rx(cp_dma_hal_context_t *hal);
|
||||
/**@}*/
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
@@ -1,151 +0,0 @@
|
||||
/*
|
||||
* SPDX-FileCopyrightText: 2020-2022 Espressif Systems (Shanghai) CO LTD
|
||||
*
|
||||
* SPDX-License-Identifier: Apache-2.0
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
#include <stdint.h>
|
||||
#include <stdbool.h>
|
||||
#include "soc/cp_dma_struct.h"
|
||||
|
||||
#define CP_DMA_LL_EVENT_RX_DONE (1 << 0)
|
||||
#define CP_DMA_LL_EVENT_RX_EOF (1 << 1)
|
||||
#define CP_DMA_LL_EVENT_TX_DONE (1 << 2)
|
||||
#define CP_DMA_LL_EVENT_TX_EOF (1 << 3)
|
||||
#define CP_DMA_LL_EVENT_RX_DESC_ERR (1 << 4)
|
||||
#define CP_DMA_LL_EVENT_TX_DESC_ERR (1 << 5)
|
||||
#define CP_DMA_LL_EVENT_RX_DESC_EMPTY (1 << 6)
|
||||
#define CP_DMA_LL_EVENT_TX_TOTAL_EOF (1 << 7)
|
||||
#define CP_DMA_LL_EVENT_ALL (0xFF)
|
||||
|
||||
/**
|
||||
* Copy DMA firstly reads data to be transferred from internal RAM,
|
||||
* stores the data into DMA FIFO via an outlink,
|
||||
* and then writes the data to the destination internal RAM via an inlink.
|
||||
*/
|
||||
|
||||
static inline void cp_dma_ll_reset_in_link(cp_dma_dev_t *dev)
|
||||
{
|
||||
dev->dma_conf.dma_in_rst = 1;
|
||||
dev->dma_conf.dma_in_rst = 0;
|
||||
}
|
||||
|
||||
static inline void cp_dma_ll_reset_out_link(cp_dma_dev_t *dev)
|
||||
{
|
||||
dev->dma_conf.dma_out_rst = 1;
|
||||
dev->dma_conf.dma_out_rst = 0;
|
||||
}
|
||||
|
||||
static inline void cp_dma_ll_reset_fifo(cp_dma_dev_t *dev)
|
||||
{
|
||||
dev->dma_conf.dma_fifo_rst = 1;
|
||||
dev->dma_conf.dma_fifo_rst = 0;
|
||||
}
|
||||
|
||||
static inline void cp_dma_ll_reset_cmd_fifo(cp_dma_dev_t *dev)
|
||||
{
|
||||
dev->dma_conf.dma_cmdfifo_rst = 1;
|
||||
dev->dma_conf.dma_cmdfifo_rst = 0;
|
||||
}
|
||||
|
||||
static inline void cp_dma_ll_enable_owner_check(cp_dma_dev_t *dev, bool enable)
|
||||
{
|
||||
dev->dma_conf.dma_check_owner = enable;
|
||||
dev->dma_conf.dma_out_auto_wrback = 1;
|
||||
dev->dma_conf.dma_out_owner = 0;
|
||||
dev->dma_conf.dma_in_owner = 0;
|
||||
}
|
||||
|
||||
static inline void cp_dma_ll_enable_clock(cp_dma_dev_t *dev, bool enable)
|
||||
{
|
||||
dev->dma_conf.dma_clk_en = enable;
|
||||
}
|
||||
|
||||
static inline void cp_dma_ll_enable_intr(cp_dma_dev_t *dev, uint32_t mask, bool enable)
|
||||
{
|
||||
if (enable) {
|
||||
dev->dma_int_ena.val |= mask;
|
||||
} else {
|
||||
dev->dma_int_ena.val &= ~mask;
|
||||
}
|
||||
}
|
||||
|
||||
static inline __attribute__((always_inline)) uint32_t cp_dma_ll_get_intr_status(cp_dma_dev_t *dev)
|
||||
{
|
||||
return dev->dma_int_st.val;
|
||||
}
|
||||
|
||||
static inline __attribute__((always_inline)) void cp_dma_ll_clear_intr_status(cp_dma_dev_t *dev, uint32_t mask)
|
||||
{
|
||||
dev->dma_int_clr.val = mask;
|
||||
}
|
||||
|
||||
static inline void cp_dma_ll_tx_set_descriptor_base_addr(cp_dma_dev_t *dev, uint32_t address)
|
||||
{
|
||||
dev->dma_out_link.dma_outlink_addr = address;
|
||||
}
|
||||
|
||||
static inline void cp_dma_ll_rx_set_descriptor_base_addr(cp_dma_dev_t *dev, uint32_t address)
|
||||
{
|
||||
dev->dma_in_link.dma_inlink_addr = address;
|
||||
}
|
||||
|
||||
static inline void cp_dma_ll_start_tx(cp_dma_dev_t *dev, bool enable)
|
||||
{
|
||||
if (enable) {
|
||||
dev->dma_out_link.dma_outlink_start = 1; // cleared automatically by HW
|
||||
} else {
|
||||
dev->dma_out_link.dma_outlink_stop = 1; // cleared automatically by HW
|
||||
}
|
||||
}
|
||||
|
||||
static inline void cp_dma_ll_start_rx(cp_dma_dev_t *dev, bool enable)
|
||||
{
|
||||
if (enable) {
|
||||
dev->dma_in_link.dma_inlink_start = 1; // cleared automatically by HW
|
||||
} else {
|
||||
dev->dma_in_link.dma_inlink_stop = 1; // cleared automatically by HW
|
||||
}
|
||||
}
|
||||
|
||||
static inline void cp_dma_ll_restart_tx(cp_dma_dev_t *dev)
|
||||
{
|
||||
dev->dma_out_link.dma_outlink_restart = 1; // cleared automatically by HW
|
||||
}
|
||||
|
||||
static inline void cp_dma_ll_restart_rx(cp_dma_dev_t *dev)
|
||||
{
|
||||
dev->dma_in_link.dma_inlink_restart = 1; // cleared automatically by HW
|
||||
}
|
||||
|
||||
// get the address of last rx descriptor
|
||||
static inline uint32_t cp_dma_ll_get_rx_eof_descriptor_address(cp_dma_dev_t *dev)
|
||||
{
|
||||
return dev->dma_in_eof_des_addr.dma_in_suc_eof_des_addr;
|
||||
}
|
||||
|
||||
// get the address of last tx descriptor
|
||||
static inline uint32_t cp_dma_ll_get_tx_eof_descriptor_address(cp_dma_dev_t *dev)
|
||||
{
|
||||
return dev->dma_out_eof_des_addr.dma_out_eof_des_addr;
|
||||
}
|
||||
|
||||
static inline uint32_t cp_dma_ll_get_tx_status(cp_dma_dev_t *dev)
|
||||
{
|
||||
return dev->dma_out_st.val;
|
||||
}
|
||||
|
||||
static inline uint32_t cp_dma_ll_get_rx_status(cp_dma_dev_t *dev)
|
||||
{
|
||||
return dev->dma_in_st.val;
|
||||
}
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
Reference in New Issue
Block a user