sf_power_profiles_v2_api_t Struct Reference

#include <sf_power_profiles_v2_api.h>

Data Fields
ssp_err_t(*	open )(sf_power_profiles_v2_ctrl_t *const p_ctrl, sf_power_profiles_v2_cfg_t const *const p_cfg)
ssp_err_t(*	runApply )(sf_power_profiles_v2_ctrl_t *const p_ctrl, sf_power_profiles_v2_run_cfg_t const *const p_cfg)
ssp_err_t(*	lowPowerApply )(sf_power_profiles_v2_ctrl_t *const p_ctrl, sf_power_profiles_v2_low_power_cfg_t const *const p_cfg)
ssp_err_t(*	close )(sf_power_profiles_v2_ctrl_t *const p_ctrl)
ssp_err_t(*	versionGet )(ssp_version_t *const p_version)

Detailed Description

Framework Power Profiles v2 API structure. Implementations will use the following API.

Field Documentation

close

ssp_err_t(* sf_power_profiles_v2_api_t::close) (sf_power_profiles_v2_ctrl_t *const p_ctrl)

Closes the framework.

Implemented as

• SF_POWER_PROFILES_V2_Close()

Parameters

[in]

p_ctrl

Pointer to control block set in SF_POWER_PROFILES_V2_Open.

lowPowerApply

ssp_err_t(* sf_power_profiles_v2_api_t::lowPowerApply) (sf_power_profiles_v2_ctrl_t *const p_ctrl, sf_power_profiles_v2_low_power_cfg_t const *const p_cfg)

Applies a Low Power profile.

Implemented as

• SF_POWER_PROFILES_V2_LowPowerApply()

Parameters

[in]	p_ctrl	Pointer to control block set in SF_POWER_PROFILES_V2_Open.
[in]	p_cfg	Pointer to configuration structure. Elements of the structure must be set by user.

open

ssp_err_t(* sf_power_profiles_v2_api_t::open) (sf_power_profiles_v2_ctrl_t *const p_ctrl, sf_power_profiles_v2_cfg_t const *const p_cfg)

Initializes the framework.

Implemented as

• SF_POWER_PROFILES_V2_Open()

Parameters

[in,out]	p_ctrl	Pointer to a structure allocated by user. Elements initialized here.
[in]	p_cfg	Pointer to configuration structure. Elements of the structure must be set by user.

runApply

ssp_err_t(* sf_power_profiles_v2_api_t::runApply) (sf_power_profiles_v2_ctrl_t *const p_ctrl, sf_power_profiles_v2_run_cfg_t const *const p_cfg)

Applies a Run profile.

Implemented as

• SF_POWER_PROFILES_V2_RunApply()

Parameters

[in]	p_ctrl	Pointer to control block set in SF_POWER_PROFILES_V2_Open.
[in]	p_cfg	Pointer to configuration structure. Elements of the structure must be set by user.

versionGet

ssp_err_t(* sf_power_profiles_v2_api_t::versionGet) (ssp_version_t *const p_version)

Gets version and stores it in provided pointer p_version.

Implemented as

• SF_POWER_PROFILES_V2_VersionGet()

Parameters

[out]

p_version

Code and API version used.

---

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

• sf_power_profiles_v2_api.h