Spectracom TSync User manual

SPECTRACOM LIMITED WARRANTY

1OVERVIEW........................................................................................................ 1-1

2INSTALLING AND UNINSTALLING THE DRIVER ..........................................2-1

2.1 Linux..............................................................................................................................................2-1

2.1.1 Installing the Driver........................................................................................................................2-1

2.1.2 Uninstalling the Driver....................................................................................................................2-2

2.1.3 Generating the Example Programs................................................................................................2-2

2.1.4 Generating the Upgrade Tool ........................................................................................................2-3

2.2 Solaris ...........................................................................................................................................2-4

2.2.1 Installing the Driver........................................................................................................................2-4

2.2.2 Uninstalling the Driver....................................................................................................................2-4

2.2.3 File Locations ................................................................................................................................2-5

2.2.4 Example Programs ........................................................................................................................2-5

2.3 Windows........................................................................................................................................2-6

2.3.1 Installing the Driver........................................................................................................................2-6

2.3.2 Uninstalling the Driver....................................................................................................................2-6

2.3.3 File Locations ................................................................................................................................2-6

2.3.4 Example Programs ........................................................................................................................2-7

2.3.5 Control Utility .................................................................................................................................2-7

2.3.6 Clock Daemon...............................................................................................................................2-8

3USING THE DRIVER TO UPGRADE ................................................................ 3-1

4INTERFACE TO THE DRIVER API...................................................................4-1

4.1 Header Files ..................................................................................................................................4-1

4.1.1 Tsync.h..........................................................................................................................................4-1

4.1.2 tsync_nonkts.h...........................................................................................................................4-195

4.1.3 Tsync_hw.h ...............................................................................................................................4-196

4.2 TSync-PCIe API —Routine Descriptions..................................................................................4-199

4.2.1 TSYNC_open ............................................................................................................................4-199

4.2.2 TSYNC_close............................................................................................................................4-199

4.2.3 TSYNC_get ...............................................................................................................................4-199

4.2.4 TSYNC_set................................................................................................................................4-200

4.2.5 TSYNC_waitFor.........................................................................................................................4-200

4.2.6 API Error Message Returns.......................................................................................................4-201

4.2.7 API Calls Supported by TSync ..................................................................................................4-201

4.2.8 Clock Service (CS) Calls ...........................................................................................................4-203

4.2.9 Frequency Output (FP) Calls.....................................................................................................4-213

4.2.10 Flash Manager (FS) Calls..........................................................................................................4-214

4.2.11 General Purpose Input (GI) Calls ..............................................................................................4-216

4.2.12 General Purpose Output (GO) Calls..........................................................................................4-218

4.2.13 GPS Reference Component (GR) Calls ....................................................................................4-225

4.2.14 Host Agent (HA) Calls................................................................................................................4-234

4.2.15 Host Reference (HR) Calls ........................................................................................................4-234

4.2.16 Hardware (HW) Calls.................................................................................................................4-238

4.2.17 Initializer Service (IN) Calls........................................................................................................4-246

4.2.18 IRIG Output Component (IP) Calls ............................................................................................4-246

4.2.19 IRIG Reference Component (IR) Calls ......................................................................................4-256

4.2.20 Log Service (LS) Calls...............................................................................................................4-265

4.2.21 PPS Output Component (PP) Calls ...........................................................................................4-267

4.2.22 PPS Reference Component (PR) Calls .....................................................................................4-270

4.2.23 PTP Reference Component (PTR) Calls ...................................................................................4-273

4.2.24 Reference Monitor Service (RS) Calls.......................................................................................4-282

4.2.25 Supervisor Service (SS) Calls ...................................................................................................4-286

4.2.26 Upgrade Service (US) Calls.......................................................................................................4-292

4.2.27 Oscillator Component (XO) Calls...............................................................................................4-293

4.2.28 Oscillator Monitor Service (XS) Calls.........................................................................................4-299

5EXAMPLE ROUTINES ......................................................................................5-1

5.1 Interrupt Generation ......................................................................................................................5-1

5.2 External Event Input (Time Stamping)...........................................................................................5-2

5.3 Match Time....................................................................................................................................5-3

5.4 Using the Host PC as an External Time Reference for the TSync Board ......................................5-5

5.5 Converting the GPO Outputs to 1PPS Output Signals ..................................................................5-6

5.6 Changing the TSync Board’s TimeScale to Local Time Instead of UTC........................................5-7

5.7 Operation of the TSync-cPCI-PTP.................................................................................................5-8

5.7.1 Basic Commands ..........................................................................................................................5-8

5.7.2 Basic PTP Configuration................................................................................................................5-9

5.7.3 Advanced PTP Configuration ......................................................................................................5-12

5.7.4 PTP Firmware Upgrade Instructions............................................................................................5-15

6TPRO/TSAT TIMING BOARD DRIVER API SUPPORT ................................... 6-1

6.1 Header Files ..................................................................................................................................6-1

6.1.1 Tpro.h ............................................................................................................................................6-1

6.1.2 Tpro_error_codes.h .......................................................................................................................6-5

6.2 TPRO/TSAT Driver API Support —Routine Descriptions .............................................................6-6

6.2.1 TPRO_setOscillator.......................................................................................................................6-6

6.2.2 TPRO_getLatitude.........................................................................................................................6-6

6.2.3 TPRO_getLongitude......................................................................................................................6-7

6.2.4 TPRO_getSatInfo ..........................................................................................................................6-7

6.2.5 TPRO_getTime..............................................................................................................................6-7

6.2.6 TPRO_resetFirmware....................................................................................................................6-8

6.2.7 TPRO_setHeartbeat ......................................................................................................................6-8

6.2.8 TPRO_setMatchTime ....................................................................................................................6-8

6.2.9 TPRO_setPropDelayCorr ..............................................................................................................6-9

6.2.10 TPRO_setTime..............................................................................................................................6-9

6.2.11 TPRO_setYear ............................................................................................................................6-10

6.2.12 TPRO_simEvent..........................................................................................................................6-10

6.2.13 TPRO_synchControl....................................................................................................................6-10

6.2.14 TPRO_synchStatus .....................................................................................................................6-11

6.2.15 TPRO_waitEvent.........................................................................................................................6-11

6.2.16 TPRO_waitHeartbeat...................................................................................................................6-12

6.2.17 TPRO_waitMatch ........................................................................................................................6-12

The factory driver for the Spectracom TSync boards provides the interface for multiple users to

access the board using the user API library documented herein.

The TSync card with optional GPS is a complete synchronized timecode reader/generator

package that supports multiple prioritized timing inputs. When an input is lost, the unit

automatically switches to the next input in order of priority.

The disciplined onboard oscillator is phase-locked to an external timing input, providing 5ns

resolution time. This 10 MHz oscillator, central to the TSync timing functions, uses the last

known reference to increment (“freewheel”) in the absence of a timing input.

The TSync card generates an IRIG AM and DCLS output pair, as well as 10 MHz sine wave and

1PPS outputs.

The board’s four programmable inputs may be used as event capture inputs, dedicated to your

time-tagging applications. Four user-programmable alarm and frequency outputs are also

provided. Programmable output functions include a periodic pulse or “heartbeat,” square wave,

and programmable start/stop time “alarm” output.

Key to TSync functionality is the ability to generate interrupts. Using one of the many available

Spectracom driver packages, you may configure your card using interrupt-driven algorithms to

support your unique applications.

The driver is designed to operate with 32-bit or 64-bit Linux kernel version 2.6.x and 3.x running

on a PC system with x86 compatible processor(s).

NOTE: Due to kernel version differences, the driver will need to be built before it is used. You

will need the GCC and Make utilities. You will also need the GNU C Library.

Included with the driver are example programs with source, utilizing the API library.

2.1.1 Installing the Driver

NOTE: If the system contains a previously installed version of the driver, that version must first

be uninstalled. See 2.1.2 Uninstalling the Driver below.

This driver is delivered via the archive file:

tsync.<rev>.tar.gz

Where <rev> is the current driver revision

1) Open a terminal window.

2) Make sure you are logged in as a root user.

3) Copy the driver file to a convenient directory location.

4) Change to the directory in which the driver files were copied.

5) Extract the driver using the following command:

> gunzip –c tsync.<rev>.tar.gz | tar –xvf –

6) Build the driver by issuing the commands below:

> cd tsync

> cd linux

> make clean

> make

> make install

NOTE: Due to the differences between the many Linux distributions, some build errors may

occur. The most likely cause is an incorrectly installed kernel source. Refer to the

documentation for your Linux release for instructions on installing the kernel source.

7) Load the driver by issuing the command:

> modprobe tsyncpci

8) To verify that the driver has been installed, type at the prompt:

> lsmod

9) Verify that the driver “tsyncpci” is present.

2.1.2 Uninstalling the Driver

1) Open a terminal window.

2) Make sure you are logged in as a root user.

3) Unload the driver by issuing the following command:

> rmmod tsyncpci

4) Change to the directory in which the driver files were copied.

5) Unload the driver by issuing the following commands:

> cd linux

> make uninstall

2.1.3 Generating the Example Programs

The TSync driver provides both a static library (libtsync.a) and a shared library

(libtsync.so). The example programs are built linked with the static library. To use the

example programs with the shared library, modify the example “makefile” by replacing the

libtsync.a with libtsync.so and rebuild.

1) Open a terminal window.

2) Change to the directory in which the driver and its sources were extracted.

3) Build the example programs by issuing the commands below:

> cd tsync

> cd examples

> make clean

> make

To see usage help for any example program, execute the program with no parameters:

> ./HW_GetTime

Table of contents

Other Spectracom Computer Hardware manuals

Spectracom

Spectracom TSync-PCIe User manual

Popular Computer Hardware manuals by other brands

EMC2

EMC2 VNX Series Hardware Information Guide

Panasonic

Panasonic DV0PM20105 Operation manual

Mitsubishi Electric

Mitsubishi Electric Q81BD-J61BT11 user manual

Gigabyte

Gigabyte B660M DS3H AX DDR4 user manual

Raidon

Raidon iT2300 Quick installation guide

National Instruments

National Instruments PXI-8186 user manual

Hauppauge

Hauppauge WinTV-HVR-2250 Quick installation guide

Kontron

Kontron CP6002 user guide

Manhattan

Manhattan 702843 user manual

Aphex

Aphex 230 instruction manual

AMD

AMD Phenom II Product data sheet

Intel

Intel NUC 12 Pro user guide

dbx

dbx Zone Pro 1260 user manual

Galaxy

Galaxy GHDX2-2430S-24F4D Installation and hardware reference manual

Intel

Intel AXXRMFBU4 Quick installation user's guide

Kontron

Kontron DIMM-PC/MD product manual

ST X-NUCLEO-SAFEA1B How to use

STEINWAY LYNGDORF

STEINWAY LYNGDORF SP-1 installation manual