User Manual

Boomer II User Manual & Integrator’s Guide
________________________________
____________
SDK – SCR API
BM210012WT09 51 Wavenet Technology
q Reset RPM
The application can call this function to reset the RPM. There are
several different levels of RPM reset commands that may be issued to
the RPM, as listed below:
Reset Level Description
NCL_RESET_INBOUND Flush the Inbound queue
NCL_RESET_OUTBOUND Flush the Outbound queue
NCL_RESET_BOTH Flush both the Inbound and Outbound queues
NCL_RESET_WARM Warm start: flush queues, default Native settings, remain in
Native mode
NCL_RESET_TRANS Not Supported
NCL_RESET_FULL Full reset: Power-on reset
NCL_RESET_NCL Reset NCL interpreter
NCL_RESET_OFF Power off the RPM
Prototype:
int nclResetRPM (word *usSduTag, byte ucResetLevel);
Description:
Command the RPM to perform a specified level reset
Input:
Ø usSduTag Pointer to a word where the SDU tag can be stored
Ø ucResetLevel The level of the Reset as listed in the above table
Output:
× Return value = 0 Operation was successful
× Return value  0 Operation failed. Value specifies the error type
× usSduTag Pointer to a word containing a reference of the corresponding
SDU tag which was generated by the NCL API for this command
to the RPM.
The response is posted to the corresponding RX queue associated with
the VDD session ID. If the session ID is not recognized all active RX
queues will be posted the response.