HAP_power_hmx_payload_v2 Struct Reference

#include <HAP_power.h>

Public Attributes
boolean	set_power
boolean	power_up
boolean	set_clock
boolean	pick_default
HAP_dcvs_exp_voltage_corner_t	target_corner
HAP_dcvs_exp_voltage_corner_t	min_corner
HAP_dcvs_exp_voltage_corner_t	max_corner
HAP_clk_perf_mode_t	perf_mode
uint32	freq_mhz
uint32	floor_freq_mhz
uint32	param1
uint32	param2
uint32	param3

Detailed Description

Payload for HAP_power_set_HMX_v2. Provides user flexibility to vote for HMX clock based on either voltage corner or frequency. User can also provide DCVS limits for HMX clock when DCVS participation is enabled via HAP_power_set_DCVS/_v2/_v3 options. On chipsets without separate HMX clock, requests made for target corner or frequency will return AEE_EBADPARM error.

Member Data Documentation

floor_freq_mhz

uint32 HAP_power_hmx_payload_v2::floor_freq_mhz

Floor frequency request in MHz. For floor_freq_mhz > 0, target_corner and pick_default should be set to 0. Maximum floor_freq_mhz request among the requesting clients will be considered. Maximum between the aggregated freq_mhz and floor_freq_mhz will be considered as the final frequency request.

freq_mhz

uint32 HAP_power_hmx_payload_v2::freq_mhz

Frequency request in MHz. freq_mhz requests across clients will be accumulated. For freq_mhz > 0, target_corner and pick_default should be set to 0.

max_corner

HAP_dcvs_exp_voltage_corner_t HAP_power_hmx_payload_v2::max_corner

maximum voltage corner for DCVS. See HAP_dcvs_exp_voltage_corner_t.

min_corner

HAP_dcvs_exp_voltage_corner_t HAP_power_hmx_payload_v2::min_corner

minimum voltage corner for DCVS. See HAP_dcvs_exp_voltage_corner_t.

param1

uint32 HAP_power_hmx_payload_v2::param1

Reserved

param2

uint32 HAP_power_hmx_payload_v2::param2

Reserved

param3

uint32 HAP_power_hmx_payload_v2::param3

Reserved

perf_mode

HAP_clk_perf_mode_t HAP_power_hmx_payload_v2::perf_mode

To specify clock frequency level within target voltage corner.

pick_default

boolean HAP_power_hmx_payload_v2::pick_default

Set to TRUE to select default HMX clock based on the voted Q6 core clock level from the same HAP_power_set context, otherwise FALSE. When TRUE, target_corner, freq_mhz and floor_freq_mhz params should be set to 0.

power_up

boolean HAP_power_hmx_payload_v2::power_up

Set to TRUE to turn on HMX, and FALSE to turn off.

set_clock

boolean HAP_power_hmx_payload_v2::set_clock

TRUE to consider HMX clock parameters. All the following parameters will be ignored if set to FALSE. By default, lowest HMX clock frequency will be selected. The default being 0 for pick_default, target_corner, freq_mhz and floor_freq_mhz.

set_power

boolean HAP_power_hmx_payload_v2::set_power

Set to TRUE to consider HMX power_up parameter to turn ON/OFF HMX, otherwise FALSE.

target_corner

HAP_dcvs_exp_voltage_corner_t HAP_power_hmx_payload_v2::target_corner

Target voltage corner. See HAP_dcvs_exp_voltage_corner_t. For target_corner > 0, pick_default, freq_mhz and floor_freq_mhz params should be set to 0. Maximum target_corner request among the requesting clients will be considered as the final vote.

---

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

• HAP_power.h