ra8_vreg.h

Go to the documentation of this file.

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

typedef enum : uint8_t {
  k_ra8_vreg_mode_ldo  = 0U, 
  k_ra8_vreg_mode_dcdc = 1U, 
} ra8_vreg_mode_t;

typedef enum : uint8_t {
  k_ra8_vreg_lv_off = 0U, 
  k_ra8_vreg_lv_p0  = 1U, 
  k_ra8_vreg_lv_p1  = 2U, 
} ra8_vreg_lv_profile_t;

typedef enum : uint8_t {
  k_ra8_vreg_standby_software       = 0U, 
  k_ra8_vreg_standby_deep_software1 = 1U, 
  k_ra8_vreg_standby_deep_software2 = 2U, 
  k_ra8_vreg_standby_deep_software3 = 3U, 
  k_ra8_vreg_standby_battery_backup = 4U, 
} ra8_vreg_standby_t;

typedef enum : uint8_t {
  k_ra8_vreg_ocp_off    = 0U, 
  k_ra8_vreg_ocp_normal = 1U, 
  k_ra8_vreg_ocp_low    = 2U, 
  k_ra8_vreg_ocp_high   = 3U, 
} ra8_vreg_ocp_t;

typedef struct {
  ra8_vreg_mode_t       mode;         
  ra8_vreg_vccsel_t     vccsel;       
  ra8_vreg_ocp_t        ocp;          
  bool                  fast_startup; 
  bool                  ldo_boost;    
  ra8_vreg_lv_profile_t lv_profile;   
} ra8_vreg_cfg_t;

typedef struct {
  uint8_t               dcdcctl;      
  uint8_t               vccsel;       
  uint8_t               lvocr;        
  ra8_vreg_mode_t       mode;         
  ra8_vreg_vccsel_t     vccsel_dec;   
  ra8_vreg_lv_profile_t lv_profile;   
  ra8_vreg_ocp_t        ocp;          
  bool                  dcdc_ready;   
  bool                  fast_startup; 
  bool                  ldo_boost;    
  bool                  io_buf_on;    
} ra8_vreg_status_t;

typedef void (*ra8_vreg_event_fn_t)(void* ctx, uint8_t status_word);
 
/* =============================================================================
 * Lifecycle
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_vreg_init(const ra8_vreg_cfg_t* cfg);

[[nodiscard]] ra8_err_t ra8_vreg_deinit(void);
 
/* =============================================================================
 * Runtime control
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_vreg_set_mode(ra8_vreg_mode_t mode);

[[nodiscard]] ra8_err_t ra8_vreg_set_vccsel(ra8_vreg_vccsel_t sel);

[[nodiscard]] ra8_err_t ra8_vreg_set_ocp(ra8_vreg_ocp_t level);

[[nodiscard]] ra8_err_t ra8_vreg_set_fast_startup(bool enable);

[[nodiscard]] ra8_err_t ra8_vreg_set_ldo_boost(bool enable);

[[nodiscard]] ra8_err_t ra8_vreg_set_lv_profile(ra8_vreg_lv_profile_t profile);
 
/* =============================================================================
 * Status
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_vreg_get_status(ra8_vreg_status_t* out);

[[nodiscard]] ra8_err_t ra8_vreg_clear_status(uint8_t mask);

[[nodiscard]] ra8_err_t ra8_vreg_reset(void);
 
/* =============================================================================
 * Power transition
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_vreg_enter_standby(ra8_vreg_standby_t variant);

[[nodiscard]] ra8_err_t ra8_vreg_enter_stop(void);

[[nodiscard]] ra8_err_t ra8_vreg_exit_standby(void);

[[nodiscard]] ra8_err_t ra8_vreg_exit_stop(void);
 
/* =============================================================================
 * IRQ hook
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_vreg_attach_handler(ra8_vreg_event_fn_t fn, void* ctx);

void ra8_vreg_dispatch(void);
 
#ifdef __cplusplus
}
#endif