swiConfigSec8KClock

Defines the source of the secondary 8 kHz clock on the bus.

Prototype

DWORD swiConfigSec8KClock ( SWIHD swihd, DWORD source, DWORD network)

Argument

Description

swihd

Switch handle.

source

Clock source for the secondary 8 kHz signal on a board. Refer to the Details section for acceptable values.

network

Device source of the secondary 8 kHz signal when source is MVIP95_SOURCE_NETWORK. Refer to the Details section for acceptable values.


Return values

Return value

Description

SUCCESS

 

CTAERR_DRIVER_ERROR

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.

CTAERR_SVR_COMM

Communication error in the server environment.

SWIERR_INVALID_CLOCK_PARM

Value of a clock configuration parameter is invalid.

SWIERR_INVALID_PARAMETER

Board-specific clock parameter value is invalid.


Details

swiConfigSec8KClock establishes the source of the secondary 8 kHz clock on the bus.

Note: Call swiConfigBoardClock before calling swiConfigSec8KClock for the first time on a particular switch handle, to prevent the clock source from changing to OSC.

Acceptable values for source are:

Acceptable values for network are 1 to n where n is the number of devices on the board. Some devices are not capable of being a source for SEC8K. Refer to the device-specific hardware documentation for the devices that are capable of being a source for SEC8K.

Refer to Configuring the clocks for more information.

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

See also

swiConfigNetrefClock, swiGetBoardClock, swiGetTimingReference, swiOpenSwitch

Example

void myT1ClockInit(SWIHD swihd)
{
    SWI_CLOCK_ARGS boardclock;

    /* Make board sync off MVIP bus clock */
    boardclock.size = sizeof(SWI_CLOCK_ARGS);
    boardclock.clocktype = MVIP95_STD_CLOCKING;
    boardclock.clocksource = MVIP95_SOURCE_MVIP;
    swiConfigBoardClock(swihd, &boardclock);

    /* Make board's network 1 provide the source of the Sec8K signal */
    swiConfigSec8KClock(swihd, MVIP95_SOURCE_NETWORK, 1);
}