PWRM_registerNotify
2-326
C Interface
Syntax
status = PWRM_registerNotify(eventType, eventMask, notifyFxn,
clientArg, notifyHandle, delayedCompletionFxn);
Parameters
PWRM_Event
eventType;
/* type of power event */
LgUns
eventMask;
/* event-specific mask */
Fxn
notifyFxn;
/* function to call on event */
Arg
clientArg;
/* argument to pass to notifyFxn */
PWRM_NotifyHandle
*notifyHandle; /* handle for unregistering */
Fxn
*delayedCompletionFxn; /* fxn to call if delay */
Return Value
PWRM_Status
status;
/* returned status */
Reentrant
yes
Description
PWRM_registerNotify registers a function to be called when a specific
power event occurs. Registrations and the corresponding notifications
are processed in FIFO order. The function registered must behave as
described in the pwrmNotifyFxn section.
The eventType parameter identifies the type of power event for which the
notify function being registered is to be called. This parameter has an
enumerated type of PWRM_Event. This parameter may have one of the
following values:
PWRM_registerNotify
Register a function to be called on a specific power event
Value
Meaning
PWRM_PENDINGSETPOINTCHANGE
V/F setpoint is about to
change.
PWRM_DONESETPOINTCHANGE
The pending V/F setpoint
change has now been made.
PWRM_GOINGTODEEPSLEEP
The DSP is going to deep
sleep.
PWRM_AWAKEFROMDEEPSLEEP
The DSP has awoken from
deep sleep.
PWRM_GOINGTOSNOOZE
The DSP is going to snooze
mode.
PWRM_AWAKEFROMSNOOZE
The DSP has awoken from
snooze.
PWRM_GOINGTOSLEEPUNTILRESTART
DSP going to deep sleep and
must be restarted to resume.