ra8_pwr.h

Go to the documentation of this file.

 
#pragma once
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdint.h>
 
#include "ra8_cgc.h"
#include "ra8_err.h"
#include "ra8_mstp_regs.h"
 
/* =============================================================================
 * Wake-up source identifiers
 * =============================================================================
 */

typedef enum : uint8_t {
  k_ra8_pwr_wupen_reg_0 = 0U, 
  k_ra8_pwr_wupen_reg_1 = 1U, 
} ra8_pwr_wupen_reg_t;

typedef enum : uint16_t {
  k_ra8_pwr_wake_irq0 = (uint16_t)(k_ra8_pwr_wupen_reg_0 << 8),        
  k_ra8_pwr_wake_irq1 = (uint16_t)((k_ra8_pwr_wupen_reg_0 << 8) | 1U), 
  k_ra8_pwr_wake_irq2 = (uint16_t)((k_ra8_pwr_wupen_reg_0 << 8) | 2U), 
  k_ra8_pwr_wake_irq3 = (uint16_t)((k_ra8_pwr_wupen_reg_0 << 8) | 3U), 
  k_ra8_pwr_wake_irq4 = (uint16_t)((k_ra8_pwr_wupen_reg_0 << 8) | 4U), 
  k_ra8_pwr_wake_irq5 = (uint16_t)((k_ra8_pwr_wupen_reg_0 << 8) | 5U), 
  k_ra8_pwr_wake_irq6 = (uint16_t)((k_ra8_pwr_wupen_reg_0 << 8) | 6U), 
  k_ra8_pwr_wake_irq7 = (uint16_t)((k_ra8_pwr_wupen_reg_0 << 8) | 7U), 
 
  k_ra8_pwr_wake_iwdt = (uint16_t)((k_ra8_pwr_wupen_reg_0 << 8) | 16U), 
  k_ra8_pwr_wake_lvd1 = (uint16_t)((k_ra8_pwr_wupen_reg_0 << 8) | 18U), 
  k_ra8_pwr_wake_lvd2 = (uint16_t)((k_ra8_pwr_wupen_reg_0 << 8) | 19U), 
  k_ra8_pwr_wake_rtc_alarm =
    (uint16_t)((k_ra8_pwr_wupen_reg_0 << 8) | 24U), 
  k_ra8_pwr_wake_rtc_period =
    (uint16_t)((k_ra8_pwr_wupen_reg_0 << 8) | 25U), 
  k_ra8_pwr_wake_usbhs_resume =
    (uint16_t)((k_ra8_pwr_wupen_reg_0 << 8) | 26U), 
  k_ra8_pwr_wake_usbfs_resume =
    (uint16_t)((k_ra8_pwr_wupen_reg_0 << 8) | 27U), 
 
  k_ra8_pwr_wake_agt0  = (uint16_t)(k_ra8_pwr_wupen_reg_1 << 8),        
  k_ra8_pwr_wake_agt1  = (uint16_t)((k_ra8_pwr_wupen_reg_1 << 8) | 1U), 
  k_ra8_pwr_wake_ulpt0 = (uint16_t)((k_ra8_pwr_wupen_reg_1 << 8) | 2U), 
  k_ra8_pwr_wake_ulpt1 = (uint16_t)((k_ra8_pwr_wupen_reg_1 << 8) | 3U), 
} ra8_pwr_wake_t;
 
/* =============================================================================
 * Lifecycle
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_pwr_init(void);
 
/* =============================================================================
 * Module request / release
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_pwr_module_request(ra8_mstp_t id);

[[nodiscard]] ra8_err_t ra8_pwr_module_release(ra8_mstp_t id);
 
/* =============================================================================
 * Wake source enable / disable
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_pwr_set_wake_source(ra8_pwr_wake_t source);

[[nodiscard]] ra8_err_t ra8_pwr_clear_wake_source(ra8_pwr_wake_t source);

[[nodiscard]] ra8_err_t ra8_pwr_wake_source_is_enabled(ra8_pwr_wake_t source, bool* out_enabled);
 
/* =============================================================================
 * Sleep entry
 * =============================================================================
 */

void ra8_pwr_enter_sleep(void);

[[nodiscard]] ra8_err_t ra8_pwr_enter_software_standby(void);
 
/* =============================================================================
 * Clock-domain forwarding
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_pwr_get_clock_hz(ra8_clock_id_t id, uint32_t* out_hz);
 
#ifdef __cplusplus
}
#endif