NCM_SetTDMBusValue( )

---

Description | Cautions | Example | Error Codes | See Also

Name:	NCM_RetCode NCM_SetTDMBusValue(pncmBus, pvariable, pvalue )
Inputs:	NCMDevice *pncmBus	pointer to the specific bus name
	NCMVariable *pvariable	pointer to a structure containing the variable name
	NCMValue *pvalue	pointer to value to set
Returns:	NCM_SUCCESS if success NCM error code if failure
Includes:	NCMApi.h
Mode:	synchronous

Description

The NCM_SetTDMBusValue( ) function sets the values of the TDM bus. Variables under the TDM Bus family with "User Defined" in the parameter name can be changed by the user. Those with "Resolved" cannot.

For additional information about using this function, see Section 2.10, Clock Master Fallback List.

The function parameters are defined as follows:

Parameter	Description
pncmBus	pointer to a structure containing a specific bus name, for example, "Bus-0"
pvariable	pointer to a structure containing the name of the variable
pvalue	pointer to a structure containing the name of the value to be set

Cautions

If you pass in a variable that cannot be modified, the function will return NCME_ACCESS_DENIED.

The variable must be a valid parameter under the TDM Bus configuration; otherwise, the function returns NCME_INVALID_INPUTS.

Currently, only a single bus is supported. Therefore, the bus name for the parameter pncmBus should be "Bus-0".

Example

#include "NCMApi.h" 
... 
//
// Prepare inputs
// 
NCMDevice bus;
device.name = "Bus-0";
device.next = NULL; 
NCMVariable variable;
variable.name = "Derive Primary Clock From (User Defined)";
variable.next = NULL; 
NCMValue value;
value.name = "InternalOscillator";
value.next = NULL; 
//
// Execute
// 
//set Primary Master FRU clock to Internal Oscillator
NCMRetCode     ncmRc = NCM_SetTDMBusValue( &bus, &variable, &value ); 
if ( ncmRc != NCM_SUCCESS )
{     // Process error
     ...
} 
... 

Error Codes

Equate	Returned When
NCME_MEM_ALLOC	memory could not be allocated to perform the function
NCME_GENERAL	a problem occurred retrieving the data
NCME_CTBB_LIB	a failure to load the CTBB library occurred
NCME_CTBB_USERAPPLY	error updating the TDM Bus parameters
NCME_INVALID_INPUTS	the values of the parameters supplied are invalid
NCME_ACCESS_DENIED	variable has read-only access or is unmodifiable

See Also

• NCM_GetClockMasterFallbackList( )
• NCM_GetTDMBusValue( )
• NCM_SetClockMasterFallbackList( )

Click here to contact Telecom Support Resources