ra8_poeg.c

Go to the documentation of this file.

 
#include "ra8_poeg.h"
 
#include <stdint.h>
 
#include "ra8_attributes.h"
#include "ra8_check.h"
#include "ra8_err.h"
#include "ra8_log.h"
#include "ra8_mstp.h"
#include "ra8_mstp_regs.h"
#include "ra8_poeg_regs.h"
 
static const char* s_tag = "POEG";

static const ra8_mstp_t s_poeg_mstp_table[k_ra8_poeg_group_count] = {
  k_ra8_mstp_poeg_a,
  k_ra8_mstp_poeg_b,
  k_ra8_mstp_poeg_c,
  k_ra8_mstp_poeg_d,
};

typedef enum : uint32_t {
  k_ra8_poeg_status_all = k_ra8_poeg_status_pidf | k_ra8_poeg_status_iocf | k_ra8_poeg_status_ovrf |
                          k_ra8_poeg_status_ssf | k_ra8_poeg_status_st, 
} ra8_poeg_bits_t;

typedef struct {
  ra8_poeg_event_fn_t fn;  
  void*               ctx; 
} ra8_poeg_state_t;
 
static ra8_poeg_state_t s_poeg_state[k_ra8_poeg_group_count];

RA8_INTERNAL static uint32_t internal_cfg_to_poegg(const ra8_poeg_cfg_t* cfg)
{
  uint32_t v = 0U;
  if (cfg->enable_pin) {
    v |= k_ra8_poeg_en_pide;
  }
  if (cfg->enable_ioc) {
    v |= k_ra8_poeg_en_iocen;
  }
  if (cfg->enable_osc_stop) {
    v |= k_ra8_poeg_en_osten;
  }
  if (cfg->invert_input) {
    v |= k_ra8_poeg_en_inv;
  }
  return v;
}

ra8_err_t ra8_poeg_init(uint8_t group, const ra8_poeg_cfg_t* cfg)
{
  RA8_CHECK_NULL_PTR(cfg, s_tag, "cfg must not be nullptr");
  volatile r_poeg_regs_t* reg = ra8_poeg(group);
  RA8_CHECK_NULL_PTR(reg, s_tag, "group out of range");
 
  /* HUM Ch 11.2.9 "MSTPCRD : Module Stop Control Register D", p 448 */
  const ra8_err_t mst_err = ra8_mstp_enable(s_poeg_mstp_table[group]);
  /* GCOVR_EXCL_BR_START -- MSTP HW readback */
  RA8_RETURN_ON_ERROR(mst_err, s_tag, "poeg_init: mstp enable");
  /* GCOVR_EXCL_BR_STOP */
 
  /* HUM Ch 21.2.1 "POEGG : POEG Group n Setting Register", p 872 */
  reg->POEGG = internal_cfg_to_poegg(cfg);
  ra8_log_info_val(s_tag, "init group", (uint32_t)group);
  return k_ra8_ok;
}

ra8_err_t ra8_poeg_deinit(uint8_t group)
{
  volatile r_poeg_regs_t* reg = ra8_poeg(group);
  RA8_CHECK_NULL_PTR(reg, s_tag, "group out of range");
 
  reg->POEGG              = 0U;
  s_poeg_state[group].fn  = nullptr;
  s_poeg_state[group].ctx = nullptr;
  (void)ra8_mstp_disable(s_poeg_mstp_table[group]);
  return k_ra8_ok;
}

ra8_err_t ra8_poeg_trigger_stop(uint8_t group)
{
  volatile r_poeg_regs_t* reg = ra8_poeg(group);
  RA8_CHECK_NULL_PTR(reg, s_tag, "group out of range");
 
  reg->POEGG |= k_ra8_poeg_status_ssf;
  return k_ra8_ok;
}

ra8_err_t ra8_poeg_get_status(uint8_t group, uint32_t* out_mask)
{
  RA8_CHECK_NULL_PTR(out_mask, s_tag, "out_mask must not be nullptr");
  volatile const r_poeg_regs_t* reg = ra8_poeg(group);
  RA8_CHECK_NULL_PTR(reg, s_tag, "group out of range");
 
  *out_mask = reg->POEGG & k_ra8_poeg_status_all;
  return k_ra8_ok;
}

ra8_err_t ra8_poeg_clear_status(uint8_t group, uint32_t mask)
{
  volatile r_poeg_regs_t* reg = ra8_poeg(group);
  RA8_CHECK_NULL_PTR(reg, s_tag, "group out of range");
 
  const uint32_t current = reg->POEGG;
  reg->POEGG             = current & ~(mask & k_ra8_poeg_status_all);
  return k_ra8_ok;
}

ra8_err_t ra8_poeg_attach_handler(uint8_t group, ra8_poeg_event_fn_t fn, void* ctx)
{
  if (group >= (uint8_t)k_ra8_poeg_group_count) {
    return k_ra8_err_invalid_arg;
  }
  s_poeg_state[group].fn  = fn;
  s_poeg_state[group].ctx = ctx;
  return k_ra8_ok;
}

ra8_err_t ra8_poeg_enter_stop(uint8_t group)
{
  if (group >= (uint8_t)k_ra8_poeg_group_count) {
    return k_ra8_err_invalid_arg;
  }
  return ra8_mstp_disable(s_poeg_mstp_table[group]);
}

ra8_err_t ra8_poeg_exit_stop(uint8_t group)
{
  if (group >= (uint8_t)k_ra8_poeg_group_count) {
    return k_ra8_err_invalid_arg;
  }
  return ra8_mstp_enable(s_poeg_mstp_table[group]);
}

RA8_ISR_SAFE
void ra8_poeg_dispatch(uint8_t group)
{
  if (group >= (uint8_t)k_ra8_poeg_group_count) {
    return;
  }
  volatile const r_poeg_regs_t* reg  = ra8_poeg(group);
  uint32_t                      mask = 0U;
  if (reg != nullptr) {
    mask = reg->POEGG & k_ra8_poeg_status_all;
  }
  const ra8_poeg_event_fn_t fn  = s_poeg_state[group].fn;
  void* const               ctx = s_poeg_state[group].ctx;
  if (fn != nullptr) {
    fn(ctx, mask);
  }
}