ra8_lpm.h

Go to the documentation of this file.

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

typedef struct {
  bool                  io_port_keep;     
  bool                  opa_bus_keep;     
  bool                  sscr_fast_return; 
  ra8_lpm_dcssmode_t    dcdc_softstart;   
  ra8_lpm_sscr1_ss2lp_t sscr_low_power;   
} ra8_lpm_config_t;

typedef struct {
  ra8_lpm_ldo_state_t pll1; 
  ra8_lpm_ldo_state_t pll2; 
  ra8_lpm_ldo_state_t hoco; 
} ra8_lpm_ldo_cfg_t;

typedef struct {
  uint16_t pdramscr0_bits; 
  bool     cpu0_tcm_keep;  
  bool     cpu1_tcm_keep;  
} ra8_lpm_ram_retention_t;

typedef enum : uint32_t {
  k_ra8_lpm_pd_timeout_default = 100000U, 
} ra8_lpm_pd_timeout_t;

typedef enum : uint8_t {
  k_ra8_lpm_clock_moco  = 0U, 
  k_ra8_lpm_clock_hoco  = 1U, 
  k_ra8_lpm_clock_loco  = 2U, 
  k_ra8_lpm_clock_main  = 3U, 
  k_ra8_lpm_clock_sub   = 4U, 
  k_ra8_lpm_clock_count = 5U, 
} ra8_lpm_clock_t;
 
/* =============================================================================
 * Lifecycle
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_lpm_init(const ra8_lpm_config_t* cfg);

[[nodiscard]] ra8_err_t ra8_lpm_deinit(void);
 
/* =============================================================================
 * PRCR unlock / relock
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_lpm_prcr_unlock(void);

[[nodiscard]] ra8_err_t ra8_lpm_prcr_relock(void);
 
/* =============================================================================
 * Wake-up source programming
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_lpm_set_wakeup_sources(uint32_t wupen0, uint32_t wupen1);

[[nodiscard]] ra8_err_t ra8_lpm_arm_wupen0_bits(uint32_t bits);

[[nodiscard]] ra8_err_t ra8_lpm_clear_wupen0_bits(uint32_t bits);

[[nodiscard]] ra8_err_t ra8_lpm_arm_wupen1_bits(uint32_t bits);

[[nodiscard]] ra8_err_t ra8_lpm_clear_wupen1_bits(uint32_t bits);
 
/* =============================================================================
 * Deep-standby cancel programming
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_lpm_arm_dpsier(ra8_lpm_dpsier_idx_t idx, uint8_t value);

[[nodiscard]] ra8_err_t ra8_lpm_clear_dpsifr(ra8_lpm_dpsier_idx_t idx);

[[nodiscard]] ra8_err_t ra8_lpm_set_dpsiegr(ra8_lpm_dpsier_idx_t idx, uint8_t value);
 
/* =============================================================================
 * Snooze controller (Standby + Snooze pattern on RA8D2)
 * =============================================================================
 */

[[nodiscard]] ra8_err_t
ra8_lpm_snooze_set_request_sources(bool ulpt0_underflow, bool ulpt1_underflow, bool acmphs0);

[[nodiscard]] ra8_err_t
ra8_lpm_snooze_set_end_sources(bool ulpt0, bool ulpt1, bool usbfs, bool usbhs);
 
/* =============================================================================
 * RAM and LDO retention
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_lpm_set_ram_retention(const ra8_lpm_ram_retention_t* cfg);

[[nodiscard]] ra8_err_t ra8_lpm_set_ldo_standby(const ra8_lpm_ldo_cfg_t* cfg);
 
/* =============================================================================
 * Clock-shutdown matrix
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_lpm_set_clock_stop(ra8_lpm_clock_t clock, bool stop);

[[nodiscard]] ra8_err_t ra8_lpm_graphics_power_on(uint32_t timeout_iters);

[[nodiscard]] ra8_err_t ra8_lpm_get_clock_stop(ra8_lpm_clock_t clock, bool* stop);
 
/* =============================================================================
 * OPCCR (Operating Power Control)
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_lpm_get_opccr(uint8_t* opccr);

[[nodiscard]] ra8_err_t ra8_lpm_wait_for_opccr(uint32_t poll_limit);
 
/* =============================================================================
 * Sleep entry
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_lpm_enter_sleep(ra8_sleep_mode_t mode);

[[nodiscard]] ra8_err_t ra8_lpm_enter_deep_standby(void);
 
/* =============================================================================
 * Status / diagnostics
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_lpm_get_status(uint32_t* out);

[[nodiscard]] ra8_err_t ra8_lpm_get_exit_cause(uint64_t* out);

[[nodiscard]] ra8_err_t
ra8_lpm_get_dpsi_state(uint8_t enables[4], uint8_t flags[4], uint8_t edges[3]);
 
#ifdef __cplusplus
}
#endif