User's Manual

Boomer-III User Manual & Integrator’s Guide______________________Appendix B – SDK NCL-API and Port Server
BM310012WT04 107 Copyright Wavenet Technology © October 2003
requests
 ucType The type of status information to retrieve from the RPM (Used by
Vendor specific requests). Set to zero for non-vendor requests or
WN_GET_STATUS = ‘?’ for Wavenet Technology specific
requests
 ucRequest The requested status information, as listed in one of the
appropriate tables above, to retrieve from the RPM.
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.
 Set Configuration ITEMS Within the RPM
By default the modem will have the receiver and transmitter enabled
and the RX notification event enabled. Modem Configuration items via
NCL are TBA and will be restricted to service personnel.
 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);