NCM_AddThirdPartyDevice( )

---

Description | Cautions | Example | Error Codes | See Also

Name:	NCMRetCode NCM_AddThirdPartyDevice(pDeviceName, TDMBusCapabilities, eMasterStatus)
Inputs:	NCMDevice* pDeviceName	third party device name that is being added
	NCM_TDM_BUSCAPS TDMBusCapabilities	TDM bus capabilities of the third party device
	NCMMasterStatus eMasterStatus	specifies the clock role of the third party device
Returns:	NCM_SUCCESS if success NCM error code if failure
Includes:	NCMApi.h
Mode:	synchronous

Description

The NCM_AddThirdPartyDevice( ) function adds a third party device to the Intel® Dialogic system. The function uses the NCM_TDM_BUSCAPS data structure to define the TDM bus capabilities of the third party device. The TDM bus capabilities indicate the following:

• bus type (H.100, H.110 or SCbus)
• if the device is capable of being defined as the primary clock master and/or the secondary clock master
• clock rate (for SCbus systems only)

The eMasterStatus parameter actually sets the TDM bus status of the third party device.

The function parameters are defined as follows:

Parameter	Description
pDeviceName	pointer to the data structure containing the name of the third party device being added
TDMBusCapabilities	indicates the TDM bus capabilities of the third party device as defined by the NCM_TDM_BUSCAPS data structure
eMasterStatus	sets the TDM bus status of the third party device. Possible values are as follows: NCM_PRIMARY- device will serve as the primary clock master in the system NCM_SECONDARY- device will serve as the secondary clock master in the system NCM_SLAVE- device will be a slave in the system

Cautions

• You cannot set the pDeviceName parameter to NULL.
• You must ensure that each third party device that is added to the system has a unique device name. Intel® Dialogic recommends embedding a "ThirdPartyDevice" prefix to any third party device name that is added to the system. For example, if your third party board is from XYZ company, Intel® Dialogic recommends using "ThirdPartyDevice-XYZnnn" as the device name, where nnn is a device number or an identifiable string.

Example

#include "NCMApi.h" 
NCM_TDM_BUSCAPS   busCAps;
NCMRetCode        ncmRc=NCM_SUCCESS;
NCMMasterStatus   clockStatus=NCM_PRIMARY; 
NCMDevice deviceName;
Char DeviceString[] = "ThirdPartyDevice-XYZ#1";
deviceName.name = (char *) DeviceString;
deviceName.next = NULL; 
//adding a third party device that is only SCBus/H100 capable 
BusCaps.structVersion = NCM_BUSCAPS_VER_0100;
BusCaps.bH100MasterCapable = true;
BusCaps.bH100SlaveCapable = true;
BusCaps.bH110MasterCapable = false;
BusCaps.bH110SlaveCapable = false;
BusCaps.bScbusMasterCapable = true;
BusCaps.bScbusSlaveCapable = true;
BusCaps.bMvipMasterCapable = false;
BusCaps.bMvipSlaveCapable = false;
BusCaps.bScbus2MhzCapable = false;
BusCaps.bScbus4MhzCapable = true;
BusCaps.bScbus8MhzCapable = true 
//call NCM API function:
ncmRc = NCM_AddThirdPartyDevice(deviceName, busCaps, clockStatus); 
if (ncmRc ! = NCM_SUCCESS)
{
  /*process error*/
}
else
{
   //process successful function call
}
... 

Error Codes

Equate	Returned When
NCME_INVALID_INPUTS	invalid inputs
NCME_MISSING_BUS_CAPABILITIES	invalid TDM bus capabilities
NCME_SYSTEMERROR	lack of system resources
NCME_FAIL_TO_SET_PRIMARY	device could not be set to primary clock master
NCME_FAIL_TO_SET_SECONDARY	device could not be set to secondary clock master
NCME_FAIL_TO_CONFIGURE_BUS	failure to configure TDM bus

See Also

• NCM_RemoveThirdPartyDevice( )

Click here to contact Telecom Support Resources