kopia lustrzana https://github.com/espressif/esp-idf
77 wiersze
3.5 KiB
C
77 wiersze
3.5 KiB
C
/*
|
|
* SPDX-FileCopyrightText: 2020-2024 Espressif Systems (Shanghai) CO LTD
|
|
*
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include <stdint.h>
|
|
#include <stddef.h>
|
|
#include "esp_assert.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/**
|
|
* @brief Type of DMA descriptor the aligned to 4 bytes
|
|
*/
|
|
typedef struct dma_descriptor_s dma_descriptor_t;
|
|
struct dma_descriptor_s {
|
|
struct {
|
|
uint32_t size : 12; /*!< Buffer size */
|
|
uint32_t length : 12; /*!< Number of valid bytes in the buffer */
|
|
uint32_t reversed24_27 : 4; /*!< Reserved */
|
|
uint32_t err_eof : 1; /*!< Whether the received buffer contains error */
|
|
uint32_t reserved29 : 1; /*!< Reserved */
|
|
uint32_t suc_eof : 1; /*!< Whether the descriptor is the last one in the link */
|
|
uint32_t owner : 1; /*!< Who is allowed to access the buffer that this descriptor points to */
|
|
} dw0; /*!< Descriptor Word 0 */
|
|
void *buffer; /*!< Pointer to the buffer */
|
|
dma_descriptor_t *next; /*!< Pointer to the next descriptor (set to NULL if the descriptor is the last one, e.g. suc_eof=1) */
|
|
} __attribute__((aligned(4)));
|
|
typedef dma_descriptor_t dma_descriptor_align4_t;
|
|
ESP_STATIC_ASSERT(sizeof(dma_descriptor_align4_t) == 12, "dma_descriptor_align4_t should occupy 12 bytes in memory");
|
|
|
|
/**
|
|
* @brief Type of DMA descriptor the aligned to 8 bytes
|
|
*/
|
|
typedef struct dma_descriptor_align8_s dma_descriptor_align8_t;
|
|
struct dma_descriptor_align8_s {
|
|
struct {
|
|
uint32_t size : 12; /*!< Buffer size */
|
|
uint32_t length : 12; /*!< Number of valid bytes in the buffer */
|
|
uint32_t reversed24_27 : 4; /*!< Reserved */
|
|
uint32_t err_eof : 1; /*!< Whether the received buffer contains error */
|
|
uint32_t reserved29 : 1; /*!< Reserved */
|
|
uint32_t suc_eof : 1; /*!< Whether the descriptor is the last one in the link */
|
|
uint32_t owner : 1; /*!< Who is allowed to access the buffer that this descriptor points to */
|
|
} dw0; /*!< Descriptor Word 0 */
|
|
void *buffer; /*!< Pointer to the buffer */
|
|
dma_descriptor_align8_t *next; /*!< Pointer to the next descriptor (set to NULL if the descriptor is the last one, e.g. suc_eof=1) */
|
|
} __attribute__((aligned(8)));
|
|
ESP_STATIC_ASSERT(sizeof(dma_descriptor_align8_t) == 16, "dma_descriptor_align8_t should occupy 16 bytes in memory");
|
|
|
|
#define DMA_DESCRIPTOR_BUFFER_OWNER_CPU (0) /*!< DMA buffer is allowed to be accessed by CPU */
|
|
#define DMA_DESCRIPTOR_BUFFER_OWNER_DMA (1) /*!< DMA buffer is allowed to be accessed by DMA engine */
|
|
#define DMA_DESCRIPTOR_BUFFER_MAX_SIZE (4095) /*!< Maximum size of the buffer that can be attached to descriptor */
|
|
#define DMA_DESCRIPTOR_BUFFER_MAX_SIZE_4B_ALIGNED (4095-3) /*!< Maximum size of the buffer that can be attached to descriptor, and aligned to 4B */
|
|
#define DMA_DESCRIPTOR_BUFFER_MAX_SIZE_16B_ALIGNED (4095-15) /*!< Maximum size of the buffer that can be attached to descriptor, and aligned to 16B */
|
|
|
|
/**
|
|
* Get the number of DMA descriptors required for a given buffer size.
|
|
*
|
|
* @param data_size Size to check DMA descriptor number.
|
|
* @param max_desc_size Maximum length of each descriptor
|
|
* @return Number of DMA descriptors required.
|
|
*/
|
|
static inline size_t dma_desc_get_required_num(size_t data_size, size_t max_desc_size)
|
|
{
|
|
return (data_size + max_desc_size - 1) / max_desc_size;
|
|
}
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|