Retrieves the status of a potential TDM bus clock timing reference. The timing reference may be an external digital trunk or an internal oscillator.

DWORD swiGetTimingReference ( SWIHD swihd,
DWORD referencesource,
DWORD network,
SWI_QUERY_TIMING_REFERENCE_ARGS *args,
unsigned size )

swihd Handle returned by swiOpenSwitch.

referencesource Specifies which clock reference is to be queried. Refer to the Details section for acceptable values.

network Specifies the device source for the CT Bus clock signals. Refer to the Details section for acceptable values.

args Pointer to a clock parameter structure for querying the potential timing reference. The SWI_QUERY_TIMING_REFERENCE_ARGS structure is:

typedef struct
{
    DWORD status;
    DWORD statusinfo;
} SWI_QUERY_TIMING_REFERENCE_ARGS ;

See the Details section for a description of these fields.

size Specifies the number of bytes contained in the structure.

• SUCCESS
• CTAERR_DRIVER_ERROR
  The underlying driver retrieved an unrecognized error. Call swiGetLastError to retrieve the MVIP device error code.
• CTAERR_INVALID_HANDLE
  swihd is not a valid switch handle.
• SWIERR_INVALID_CLOCK_PARM
  The value of a clock configuration parameter is invalid.
• SWIERR_INVALID_PARAMETER
  A board-specific clock parameter value is invalid.

None.

This function retrieves status information about a potential timing reference.

Acceptable values for referencesource are:

MVIP95_SOURCE_INTERNAL
MVIP95_SOURCE_NETWORK

Acceptable values for network are 1 to n where n is the number of devices on the specified board capable of being a clock source. A value for network is valid only when referencesource is equal to MVIP95_SOURCE_NETWORK.

The following table describes the fields in the SWI_QUERY_TIMING_REFERENCE_ARGS structure:

Field	Description
status	Receives the status of the timing reference. Acceptable values are: MVIP95_TIMING_REF_STATUS_GOOD MVIP95_TIMING_REF_STATUS_BAD MVIP95_TIMING_REF_STATUS_UNKNOWN
statusinfo	Receives additional optional information about the timing reference status. Acceptable values are: MVIP95_TIMING_REF_UNKNOWN MVIP95_TIMING_REF_NO_ALARM For T1 boards: MVIP95_TIMING_REF_RED_ALARM MVIP95_TIMING_REF_BLUE_ALARM MVIP95_TIMING_REF_YELLOW_ALARM For E1 boards: MVIP95_TIMING_REF_AIS MVIP95_TIMING_REF_NO_FRM MVIP95_TIMING_REF_16_AIS MVIP95_TIMING_REF_FAULT MVIP95_TIMING_REF_NO_SMF

If CTAERR_DRIVER_ERROR is returned, call swiGetLastError to retrieve the MVIP device error code.

swiConfigNetrefClock, swiGetBoardClock, swiGetLastError, swiOpenSwitch

void myGetTimingReference (SWIHD swihd)
{
    SWI_QUERY_TIMING_REFERENCE_ARGS   querytimingref;
    DWORD               referencesource;
    DWORD               network;
    unsigned                size;

    size = sizeof (SWI_QUERY_TIMING_REFERENCE_ARGS);
    swiGetTimingReference(swihd, referencesource, network, &querytimingref,
                          size);
}