ra8_power_profile.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_power_profile_max_regions = 16, 
} ra8_power_profile_limits_t;

typedef enum : uint8_t {
  k_ra8_power_profile_region_active           = 0, 
  k_ra8_power_profile_region_sleep            = 1, 
  k_ra8_power_profile_region_software_standby = 2, 
  k_ra8_power_profile_region_deep_standby     = 3, 
  k_ra8_power_profile_region_snooze           = 4, 
  k_ra8_power_profile_region_user_0           = 5, 
} ra8_power_profile_region_id_t;

typedef void (*ra8_power_profile_gpio_pulse_fn_t)(void*                         ctx,
                                                  ra8_power_profile_region_id_t region_id,
                                                  bool                          entering);

typedef uint64_t (*ra8_power_profile_now_us_fn_t)(void* ctx);

typedef struct {
  uint64_t entries;       
  uint64_t exits;         
  uint64_t total_time_us; 
  uint64_t last_enter_us; 
  bool     is_open;       
} ra8_power_profile_region_stats_t;

typedef struct {
  ra8_power_profile_region_stats_t regions[k_ra8_power_profile_max_regions];
} ra8_power_profile_stats_t;

typedef struct {
  ra8_power_profile_gpio_pulse_fn_t pulse;         
  ra8_power_profile_now_us_fn_t     now_us;        
  void*                             user_ctx_gpio; 
  void*                             user_ctx_time; 
} ra8_power_profile_config_t;

ra8_err_t ra8_power_profile_init(const ra8_power_profile_config_t* cfg);

ra8_err_t ra8_power_profile_mark_enter(ra8_power_profile_region_id_t region_id);

ra8_err_t ra8_power_profile_mark_exit(ra8_power_profile_region_id_t region_id);

ra8_err_t ra8_power_profile_get_stats(ra8_power_profile_stats_t* out_stats);

ra8_err_t ra8_power_profile_reset_stats(void);
 
#ifdef __cplusplus
}
#endif