NCM_SetClockMasterFallbackList( )

---

Description | Cautions | Example | Error Codes | See Also

Name:	NCMRetCode NCM_SetClockMasterFallbackList(pncmBus, pfallbackList )
Inputs:	NCMDevice *pncmBus	pointer to a structure containing a specific bus name
	NCMDevice *pfallbackList	pointer to list of devices to be set
Returns:	NCM_SUCCESS if success NCM error code if failure
Includes:	NCMApi.h
Mode:	synchronous

Description

The NCM_SetClockMasterFallbackList( ) function sets the clock fallback list.

This function will issue a CTBB_UserApply to validate the changes. If the CTBB returns an error, then the list will not be set and previous values remain unchanged. For more information about defining the master clock fallback list, see Section 2.10, Clock Master Fallback List.

The function parameters are defined as follows:

Parameter	Description
pncmBus	pointer to the a structure containing a specific bus name, for example, "Bus-0"
pfallbackList	pointer to device list to be set in the clock fallback list

Cautions

NCM Device structure to be passed in is of a single link list form.

Currently, only one bus is supported. Therefore, the parameter pncmBus should equal "Bus-0".

The clock fallback list is created in order of user's preference. The first device listed will be the Primary Clock Master, the second device listed will be the Secondary Clock Master, the third device listed will be the next fallback reference clock, and each subsequent device listed will be considered by the system, in order, as a fallback clock source. The list will end with an NCMString = NULL.

If only one device is defined in the list, this device will be the Primary Clock Master, and the system will select the Secondary Clock Master. If no devices are defined, the system will choose both the Primary and Secondary Clock Master.

Example

#include "NCMApi.h" 
... 
//
// Prepare inputs
// 
NCMDevice bus;
device.name = "Bus-0";
device.next = NULL; 
NCMDevice * pfallbackList;
NCMDevice * pCurrList = pfallbackList; 
//Populate List
while ( )
{
     // Populate List
     ...
     pCurrList = pCurrList->next;
     pCurrList->next = NULL;
} 
//
// Execute
// 
NCMRetCode     ncmRc = NCM_SetClockMasterFallbackList( &bus, pfallbackList ); 
if ( ncmRc != NCM_SUCCESS )
{     // Process error
     ...
} 

Error Codes

Equate	Returned When
NCME_GENERAL	a problem occurred retrieving the data
NCME_DATA_NOT_FOUND	requested data not found in NCM data storage
NCME_CTBB_LIB	the system failed to load the CTBB library
NCME_CTBB_USERAPPLY	error updating the TDM Bus parameters
NCME_INVALID_INPUTS	the values of the parameters supplied are invalid
NCME_MEM_ALLOC	memory could not be allocated to perform the function

See Also

• NCM_GetClockMasterFallbackList( )
• NCM_GetTDMBusValue( )
• NCM_SetTDMBusValue( )

Click here to contact Telecom Support Resources