HAP user PMU
HAP user PMU API
Functions
API for reading single PMU event

Functions

static int HAP_register_pmu_event (unsigned short pmu_event)
 
static unsigned int HAP_read_pmu_event (unsigned short pmu_event)
 
static int HAP_deregister_pmu_event (unsigned short pmu_event)
 

Detailed Description

These APIs allow the user to configure and read single PMU events. PMU event is used as an input in register, read and de-register APIs. Up to four unique PMU event requests can be served.

Function Documentation

◆ HAP_deregister_pmu_event()

static int HAP_deregister_pmu_event ( unsigned short  pmu_event)
inlinestatic

De-registers the PMU event registered via HAP_register_pmu_event().

Parameters
pmu_eventPMU event to de-register. It should already be registered via HAP_register_pmu_event().
Returns
0 upon success.
Other values upon failure.
HAP_USER_PMU_READ_NOT_SUPPORTED when not supported.

◆ HAP_read_pmu_event()

static unsigned int HAP_read_pmu_event ( unsigned short  pmu_event)
inlinestatic

Reads the PMU event registered via HAP_register_pmu_event().

Parameters
pmu_eventPMU event to read. Should already be registered via HAP_register_pmu_event().
Returns
The value of the PMU counter corresponding to the pmu_event.
  • HAP_USER_PMU_READ_NOT_SUPPORTED – API is unsupported.
  • HAP_USER_PMU_READ_FAILED – The given pmu_event read fails.

◆ HAP_register_pmu_event()

static int HAP_register_pmu_event ( unsigned short  pmu_event)
inlinestatic

Registers sa PMU event for read.

Parameters
pmu_eventPMU event to register.
Returns
0 upon success.
Other values upon failure.