ra8_dmac.h

Go to the documentation of this file.

 
#pragma once
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdint.h>
 
#include "ra8_err.h"

typedef enum : uint8_t {
  k_ra8_dmac_width_byte = 0U, 
  k_ra8_dmac_width_half = 1U, 
  k_ra8_dmac_width_word = 2U, 
} ra8_dmac_width_t;

typedef enum : uint8_t {
  k_ra8_dmac_mode_normal       = 0U, 
  k_ra8_dmac_mode_repeat       = 1U, 
  k_ra8_dmac_mode_block        = 2U, 
  k_ra8_dmac_mode_repeat_block = 3U, 
} ra8_dmac_mode_t;

typedef enum : uint8_t {
  k_ra8_dmac_repeat_area_dest = 0U, 
  k_ra8_dmac_repeat_area_src  = 1U, 
  k_ra8_dmac_repeat_area_none = 2U, 
} ra8_dmac_repeat_area_t;

/* cppcheck reads ra8_dmac.h without seeing tests/mocks/src/ra8_fake_dma.c or the
 * DMAC register accesses in libs/ra8_hal/src/ra8_dmac.c, so it flags
 * every field as unused even though the driver reads all of them. */
typedef struct {
  uint32_t               src;         
  uint32_t               dst;         
  uint16_t               count;       
  ra8_dmac_width_t       width;       
  bool                   src_inc;     
  bool                   dst_inc;     
  ra8_dmac_mode_t        mode;        
  uint16_t               block_count; 
  ra8_dmac_repeat_area_t repeat_area; 
  bool                   irq_each;    
  bool                   enable_dtie; 
} ra8_dmac_config_t;

[[nodiscard]] ra8_err_t ra8_dmac_start(uint8_t channel, const ra8_dmac_config_t* cfg);

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

typedef enum : uint8_t {
  k_ra8_dmac_addr_fixed     = 0U, 
  k_ra8_dmac_addr_offset    = 1U, 
  k_ra8_dmac_addr_increment = 2U, 
  k_ra8_dmac_addr_decrement = 3U, 
} ra8_dmac_addr_mode_t;

typedef void (*ra8_dmac_callback_fn_t)(void* ctx);

[[nodiscard]] ra8_err_t ra8_dmac_start_repeat(uint8_t channel, const ra8_dmac_config_t* cfg);

[[nodiscard]] ra8_err_t ra8_dmac_start_block(uint8_t channel, const ra8_dmac_config_t* cfg);

[[nodiscard]] ra8_err_t ra8_dmac_set_address_mode(uint8_t              channel,
                                                  ra8_dmac_addr_mode_t src_mode,
                                                  ra8_dmac_addr_mode_t dest_mode);

[[nodiscard]] ra8_err_t
ra8_dmac_attach_half_complete_handler(uint8_t channel, ra8_dmac_callback_fn_t fn, void* ctx);

[[nodiscard]] ra8_err_t
ra8_dmac_attach_callback(uint8_t channel, ra8_dmac_callback_fn_t fn, void* ctx);

void ra8_dmac_dispatch(uint8_t channel);

void ra8_dmac_dispatch_half(uint8_t channel);

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

[[nodiscard]] ra8_err_t ra8_dmac_is_active(uint8_t channel, bool* out_active);

[[nodiscard]] ra8_err_t ra8_dmac_wait_idle(uint8_t channel, uint32_t poll_limit);
 
#ifdef __cplusplus
}
#endif