PWRM_getNumSetpoints
Application Program Interface
2-319
C Interface
Syntax
status = PWRM_getNumSetpoints(numberSetpoints);
Parameters
Uns
*numberSetpoints; /* number of supported setpoints */
Return Value
PWRM_Status status;
/* returned status */
Reentrant
yes
Description
PWRM_getNumSetpoints returns the number of setpoints supported by
the currently configured platform.
The numberSetpoints parameter should point to the location where
PWRM_getNumSetpoints should write the number of setpoints. See
PWRM_changeSetpoint for a list of valid setpoints. If V/F scaling is
supported, the number of setpoints is greater than or equal to 1.
PWRM_getNumSetpoints returns one of the following constants as a
status value of type PWRM_Status:
Example
PWRM_Status status;
Uns numSetpoints;
status = PWRM_getNumSetpoints(&numSetpoints);
LOG_printf(TRACE, "NumSetpoints: %d", numSetpoints);
if (status != PWRM_SOK) { /* exit on error */
LOG_printf(TRACE, "Error: status = %x", status);
return;
}
PWRM_getNumSetpoints
Get the number of setpoints supported by platform
Name
Usage
PWRM_SOK
The operation succeeded.
PWRM_EFAIL
A general failure occurred.
PWRM_EINVALIDPOINTER
The operation failed because the
numberSetpoints parameter was NULL.
PWRM_EINITFAILURE
A failure occurred while initializing V/F
scaling support; V/F scaling is unavailable
PWRM_ENOTIMPLEMENTED
The operation failed because V/F scaling
is not supported.