Defines the source of the NETREF clocks on the H.100/H.110 bus.

DWORD swiConfigNetrefClock ( SWIHD swihd,
SWI_NETREF_CLOCK_ARGS *args)

swihd Handle returned by swiOpenSwitch.

args The NETREF clock configuration parameters. The SWI_NETREF_CLOCK_ARGS structure is:

typedef struct
{
 DWORD size;
 DWORD network;    
 DWORD netrefclockmode;       
 DWORD netrefclockspeed;
} SWI_NETREF_CLOCK_ARGS;    

Refer to the Details section for a description of the structure and acceptable values.

• 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 establishes the source of the NETREF clocks on the H.100/H.110 bus.

The size field specifies the number of bytes contained in the structure. If size is less than the size of SWI_NETREF_CLOCK_ARGS, the command will only use the number of bytes specified by size. If size is greater than the size of SWI_NETREF_CLOCK_ARGS, size will be set to the size of SWI_NETREF_CLOCK_ARGS, and the command will use this number of bytes.

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

Acceptable values for netref_clock_mode are:

Value	Description
MVIP95_H100_NETREF	Configuration command for the H.100 NETREF clock.
MVIP95_H100_NETREF_1	Configuration command for the H.110 NETREF_1 clock.
MVIP95_H100_NETREF_2	Configuration command for the H.110 NETREF_2 clock.

Acceptable values for netref_clock_speed are:

MVIP95_H100_NETREF_8KHZ
MVIP95_H100_NETREF_1544MHZ
MVIP95_H100_NETREF_2048MHZ
MVIP95_H100_NETREF_DISABLED

Note: If the MVIP95_H100_NETREF_DISABLED value is used, the board stops driving the NETREF specified in the netref_clock_mode field.

Refer to Chapter 4 for more information about configuring clocks.

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

swiConfigBoardClock,swiGetBoardClock, swiGetLastError, swiGetTimingReference, swiOpenSwitch

void myNetrefClockInit(SWIHD t1hd)
{
    SWI_NETREF_CLOCK_ARGS netrefclock;

    netrefclock.size = sizeof(SWI_NETREF_CLOCK_ARGS);
    netrefclock.network = 1;
    netrefclock.netref_clock_mode = MVIP95_H100_NETREF;
    netrefclock.netref_clock_speed = MVIP95_H100_NETREF_8KHZ;
    swiConfigNetrefClock(t1hd, &netrefclock);

}