dma.h

Go to the documentation of this file.

#ifndef NEXUS_IO_DMA_H
#define NEXUS_IO_DMA_H
 
#include "nexus/core/status.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define NX_DMA_MEMORY_READ  1U
#define NX_DMA_MEMORY_WRITE 2U

typedef enum { NX_DMA_TO_DEVICE, NX_DMA_FROM_DEVICE } nx_dma_direction_t;

typedef struct {
    uintptr_t begin;
    size_t size;
    uint32_t permissions;
} nx_dma_memory_region_t;

typedef struct {
    uint8_t controller;
    uint8_t stream;
    uint8_t channel;
} nx_dma_resource_t;

typedef struct {
    size_t length;
    size_t remaining;
    bool engine_disabled;
    bool irq_detached;
    bool peripheral_idle;
} nx_dma_drain_facts_t;

nx_result_t nx_dma_buffer_validate(const nx_dma_memory_region_t* regions,
                                   size_t count, const void* data,
                                   size_t length, size_t alignment,
                                   nx_dma_direction_t direction);

nx_result_t nx_dma_resources_validate(const nx_dma_resource_t* resources,
                                      size_t count);

nx_result_t nx_dma_drain_check(const nx_dma_drain_facts_t* facts);
 
#ifdef __cplusplus
}
#endif
 
#endif