ra8_dma.h

Go to the documentation of this file.

 
#pragma once
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdint.h>
 
#include "ra8_dmac.h"
#include "ra8_elc_regs.h"
#include "ra8_err.h"
 
/* =============================================================================
 * Types
 * =============================================================================
 */

typedef enum : uint8_t {
  k_ra8_dma_channel_count = 8U, 
} ra8_dma_channel_count_t;

typedef enum : uint8_t {
  k_ra8_dma_channel_none = 0xFFU, 
} ra8_dma_invalid_channel_t;

typedef void (*ra8_dma_complete_fn_t)(void* ctx);

/* cppcheck cannot see tests/ so it flags every ra8_dma_request_t
 * field as unused; the fields are read in ra8_dma.c and in
 * tests/mocks/src/ra8_fake_dma.c. */
typedef struct {
  uintptr_t             src_addr;    
  uintptr_t             dst_addr;    
  uint16_t              count;       
  ra8_dmac_width_t      width;       
  bool                  src_inc;     
  bool                  dst_inc;     
  ra8_elc_event_t       trigger;     
  ra8_dma_complete_fn_t on_complete; 
  void*                 ctx;         
} ra8_dma_request_t;
 
/* =============================================================================
 * Lifecycle
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_dma_init(void);

[[nodiscard]] ra8_err_t ra8_dma_deinit(void);
 
/* =============================================================================
 * Request / release
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_dma_request(const ra8_dma_request_t* req, uint8_t* out_channel);

[[nodiscard]] ra8_err_t ra8_dma_release(uint8_t channel);

[[nodiscard]] ra8_err_t ra8_dma_channel_is_busy(uint8_t channel, bool* out_busy);
 
#ifdef RA8_OFF_TARGET
const ra8_dma_request_t* ra8_dma_fake_peek_request(uint8_t channel);
#endif

void ra8_dma_dispatch_complete(uint8_t channel);
 
#ifdef __cplusplus
}
#endif