Specifications

HighWire MTP-2 - 1.2, September 4, 2002 Basic Interface Functions and API Calls 35
4-3-2. cbi_terminate Prototype.
void cbi_terminate(void)
Description. This function is invoked by the user to terminate the library. It
must be invoked when the application does not wish to make any further calls
across the interface.
Parameters. None.
Returns. void.
4-3-3. cbi_open Prototype.
CBI_UINT32 cbi_open(
const char *name,
CBI_CORR * cbi_correlator,
CBI_CORR appl_correlator)
Description. This function is invoked by MTP3 to obtain a correlator for
subsequent communications to a line card. Note that a single correlator is
obtained once and is valid for any and all MTP2 instances that are eventually
created on the card.
Parameters.
Returns. CB_RC_SYNC_COMPLETE if the call is successful. Otherwise, an error
code indicating that the device does not exist, no correlators are available, or
the stream cannot be opened.
name The driver name. This parameter uniquely identifies a
line card. Its value is the path of the streams device
corresponding to the card in question. For example,
HW0_MTP2_0 is HighWire board 0. This value is null
nullnull
null for
HWMTP2 for SDK, since no Streams device exists.
cbi_correlator The dress of the correlator that the application must
supply on all subsequent calls to the interface when
addressing the line card identified by the name
parameter. Returned parameter.
appl_correlator The correlator that the application uses to identify the
line card indicated by the name parameter. The CBI
library supplies this correlator to the application on all
callbacks associated with this line card.