Initialisation configuration. More...

#include <ra8_power_profile.h>

Data Fields
ra8_power_profile_gpio_pulse_fn_t	pulse
	GPIO edge hook (may be nullptr).
ra8_power_profile_now_us_fn_t	now_us
	Clock hook, us (may be nullptr).
void *	user_ctx_gpio
	Opaque pointer passed to pulse.
void *	user_ctx_time
	Opaque pointer passed to now_us.

Detailed Description

Initialisation configuration.

Wires the profiler to the application's GPIO and time-base hooks. Either hook may be nullptr – a null GPIO hook turns the helper into a pure software accumulator (useful in unit tests); a null time-base hook disables total_time_us accumulation while still counting entries.

Invariant: user_ctx_gpio and user_ctx_time are passed through verbatim to the hooks; the profiler never inspects them.

static void board_pulse(void* c, ra8_power_profile_region_id_t r, bool e) {
    (void)c; (void)r;
    ra8_gpio_write(k_ra8_port_4, 0, e ? k_ra8_level_high : k_ra8_level_low);
}
static uint64_t board_now_us(void* c) { (void)c; return ra8_rtc_now_us(); }
 
ra8_power_profile_config_t cfg = {
    .pulse    = board_pulse,
    .now_us   = board_now_us,
};
ra8_power_profile_init(&cfg);

See also: ra8_power_profile_init

Since: 0.1.0

Definition at line 203 of file ra8_power_profile.h.

Field Documentation

◆ now_us

ra8_power_profile_now_us_fn_t ra8_power_profile_config_t::now_us

Clock hook, us (may be nullptr).

Definition at line 205 of file ra8_power_profile.h.

◆ pulse

ra8_power_profile_gpio_pulse_fn_t ra8_power_profile_config_t::pulse

GPIO edge hook (may be nullptr).

Definition at line 204 of file ra8_power_profile.h.

◆ user_ctx_gpio

void* ra8_power_profile_config_t::user_ctx_gpio

Opaque pointer passed to pulse.

Definition at line 206 of file ra8_power_profile.h.

◆ user_ctx_time

void* ra8_power_profile_config_t::user_ctx_time

Opaque pointer passed to now_us.

Definition at line 207 of file ra8_power_profile.h.

The documentation for this struct was generated from the following file:

libs/ra8_power_profile/inc/ra8_power_profile.h