Symmetricom bc635PCI-V2 User manual

Artisan Technology Group is your source for quality
new and certied-used/pre-owned equipment
• FAST SHIPPING AND
DELIVERY
• TENS OF THOUSANDS OF
IN-STOCK ITEMS
• EQUIPMENT DEMOS
• HUNDREDS OF
MANUFACTURERS
SUPPORTED
• LEASING/MONTHLY
RENTALS
• ITAR CERTIFIED
SECURE ASSET SOLUTIONS
SERVICE CENTER REPAIRS
Experienced engineers and technicians on staff
at our full-service, in-house repair center
WE BUY USED EQUIPMENT
Sell your excess, underutilized, and idle used equipment
We also offer credit for buy-backs and trade-ins
www.artisantg.com/WeBuyEquipment
REMOTE INSPECTION
Remotely inspect equipment before purchasing with
our interactive website at www.instraview.com
LOOKING FOR MORE INFORMATION?
Visit us on the web at www.artisantg.com for more
information on price quotations, drivers, technical
specications, manuals, and documentation
Contact us: (888) 88-SOURCE | [e-mail] | www.artisantg.com
SM
View
Instra

PCI / PCIe
Time and Frequency Processor
User’s Guide
Products Included:
PCI
bc635PCI-V2
bc637PCI-V2
bc635PCI-V2-OCXO
bc637PCI-V2-OCXO
PCIe
bc635PCIe
bc637PCIe
bc635PCIe-OCXO
bc637PCIe-OCXO
Product CD, 098-00179-000
November 2, 2009
Revision A
Artisan Technology Group - Quality Instrumentation ... Guaranteed | (888) 88-SOURCE | www.artisantg.com

Symmetricom Customer Assistance
Symmetricom's Customer Assistance Centers are a centralized resource to handle all of your cus-
tomer needs.
Customer Assistance Center Telephone Numbers:
nWorldwide (Main Number): 1-408-428-7907
nUSA, Canada, Latin America including Caribbean, Pacific Rim including Asia, Australia and New
Zealand: 1-408-428-7907
nUSA toll-free: 1-888-367-7966 (1-888-FOR-SYMM)
nEurope, Middle East & Africa: 49 700 32886435
Technical Support can be obtained either through the Online Support area of our website:
(http://www.symmetricom.com/support/online-support/ttm-product-support/), or by calling one of the
above Customer Assistance Center numbers.
When calling the worldwide or USA-based number, select Option 1 at the first prompt. Telecom Solu-
tions Division customers should then select Option 1; Timing, Test and Measurement Division cus-
tomers should then select Option 2.
Technical Support personnel are available by phone:
nBetween 7 a.m. to 5 p.m. Pacific Time, weekdays through the Main Customer Assistance Center
number 1-408-428-7907.
nBetween 8 a.m. to 5 p.m. Central European Time weekdays at the Europe, Middle East and
Africa number 49 700 32886435.
nAfter hours support for emergencies only is handled through the worldwide (main) number 1-408-
428-7907.
Customers who have purchased Technical Support Contracts may e-mail support requests to:
[e-mail] (Americas, Asia, Pacific Rim)
[e-mail] (Europe, Middle East, Africa)
Copyright
Copyright © 2009 Symmetricom, Inc.
All rights reserved.
Due to continued product development this information may change without notice. If you find any
errors in the documentation, please report them to us in writing. Symmetricom, Inc. does not warrant
that this document is error-free.
Artisan Technology Group - Quality Instrumentation ... Guaranteed | (888) 88-SOURCE | www.artisantg.com

Intellectual Property
The software contains proprietary information of Symmetricom, Inc.; it is provided under a license
agreement containing restrictions on use and disclosure and is also protected by copyright law.
Reverse engineering of the software is prohibited.
Limited Product Warranty
Hardware and embedded software - For a period of one (1) year from date of shipment by Sym-
metricom, Symmetricom warrants that all Products shall be free from defects in design, material, and
workmanship; shall conform to and perform in accordance with Symmetricom's published spec-
ifications, if any; shall be free and clear of any liens and encumbrances; and shall have good and valid
title. This warranty will survive inspection, acceptance, and payment by Buyer. Symmetricom does
not warrant that the operation of such Products will be uninterrupted or error free. This warranty does
not cover failures caused by acts of God, electrical or environmental conditions; abuse, negligence,
accident, loss or damage in transit; or improper site preparation.
This warranty shall be null and void in the event (i) Buyer or any third party attempts repair of the
goods without Symmetricom's advance written authorization, or (ii) defects are the result of improper
or inadequate maintenance by Buyer or third party; (iii) of damage to said goods by Buyer or third
party-supplied software, interfacing or supplies; (iv) of improper use (including termination of non-cer-
tified third party equipment on Symmetricom's proprietary interfaces and operation outside of the prod-
uct's specifications) by Buyer or third party; or (v) the goods are shipped to any country other than that
originally specified in the Buyer's purchase order.
Goods not meeting the foregoing warranty will be repaired or replaced, at Symmetricom's option,
upon return to Symmetricom's factory freight prepaid; provided, however that Buyer has first obtained
a return materials authorization number ("RMA Number") from Symmetricom authorizing such return.
The RMA Number shall be placed on the exterior packaging of all returns. Symmetricom will pay ship-
ping costs to return repaired or replacement goods to Buyer.
Symmetricom reserves the right to disallow a warranty claim following an inspection of returned prod-
uct. When a warranty claim is questioned or disallowed, Symmetricom will contact Buyer by tel-
ephone or in writing to resolve the problem.
Software - Symmetricom warrants that for a period of ninety (90) days from date of shipment by Sym-
metricom the accompanying media will be free from defects in materials and workmanship under nor-
mal use. The physical media warranty does not apply to defects arising from misuse, theft,
vandalism, fire, water, acts of God or other similar perils. Symmetricom will not be liable for any dam-
ages caused by the Buyer's failure to fulfill its responsibilities as stated above.
THE FOREGOING WARRANTY IS IN LIEU OF ALL OTHER WARRANTIES, EXPRESSED OR
IMPLIED, INCLUDING, BUT NOT LIMITED TO, ANY IMPLIED WARRANTIES OF TITLE, MER-
CHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE HOWSOEVER ARISING.
Limitation of Liability - The remedies provided herein are the Buyer's sole and exclusive remedies. In
no event or circumstances will Symmetricom be liable to Buyer for indirect, special, incidental or con-
sequential damages, including without limitation, loss of revenues or profits, business interruption
costs, loss of data or software restoration, or damages relating to Buyer's procurement of substitute
products or services. Except for liability for personal injury or property damage arising from Sym-
metricom's negligence or willful misconduct, in no event will Symmetricom's total cumulative liability
in connection with any order hereunder or Symmetricom's Goods, from all causes of action of any
Artisan Technology Group - Quality Instrumentation ... Guaranteed | (888) 88-SOURCE | www.artisantg.com

kind, including tort, contract, negligence, strict liability and breach of warranty, exceed the total
amount paid by Buyer hereunder. SOME JURISDICTIONS DO NOT ALLOW CERTAIN LIM-
ITATIONS OR EXCLUSIONS OF LIABILITY, SO THE ABOVE LIMITATIONS OR EXCLUSIONS
MAY NOT APPLY TO ALL BUYERS.
Contact Information
Symmetricom, Inc.
Timing, Test & Measurement
3750 Westwind Blvd.
Santa Rosa, CA 95403
Main: [phone]
For Sales, Technical Support, and Return Materials Authorization, please see
"Symmetricom Customer Assistance" on page ii.
Conventions
The conventions used in this manual are:
Note:Tips and clarifications
Warning:Actions to prevent equipment damage.
Bold:Used to show messages, menu items, etc., that appear on a computer screen. For example,
click on Submit Changes.
Text:Used to indicate text you should enter with your keyboard, exactly as printed.
Errata
Errata are available on the CD ROM supplied with the equipment. The errata file name is “Errata.pdf”.
Artisan Technology Group - Quality Instrumentation ... Guaranteed | (888) 88-SOURCE | www.artisantg.com

Table of Contents
Symmetricom Customer Assistance ii
Copyright ii
Intellectual Property iii
Limited Product Warranty iii
Contact Information iv
Conventions iv
Errata iv
1. PCI/PCIe TFP Hardware 1
1.1. Introduction 1
1.1.1. General Information 1
1.1.2. Key Features 4
1.1.4. Specifications and Settings 5
Time Code Inputs 5
Time Code Outputs 5
PCIe Bus Characteristics 6
PCI Bus Characteristics 6
Inputs 6
Outputs 7
bc635PCI-V2 and bc637PCI-V2 Jumpers 7
bc635PCIe and bc637PCIe Jumpers 7
Environmental Specifications 8
Front Panel LED 8
GPS Antenna 8
1.2. Installation 10
Artisan Technology Group - Quality Instrumentation ... Guaranteed | (888) 88-SOURCE | www.artisantg.com

1.2.1. General 10
1.2.2. Installing the Card and Antenna 11
Installing the Card 11
Changing the TFP Card Front Panel 11
Procedure for Changing the TFP Card Front Panel 11
Antenna Location and Installation (bc637PCI-V2 and bc637PCIe) 12
Quick Initial Setup 12
Permanent Antenna Installation 13
1.2.3. bc637PCI/PCIe Additional Hardware 14
1.2.4. Minimum System Requirements 14
1.2.5. Installation Under Windows 14
1.2.6. Windows Software Development Kit 14
1.2.7. Linux Software Development Kit 15
1.2.8. Solaris Software Development Kit 16
1.2.9. Installation Under Other Operating Systems 16
1.3. Functional Description 16
1.3.1. General 16
Mode 0 (Time Code Mode) 17
Mode 1 (Free Running Mode) 17
Mode 2 (External 1 PPS Mode) 17
Mode 3 (RTC) 17
Mode 6 (GPS) - bc637PCI-V2 and bc637PCIe 17
Time Capture Registers 18
1.3.2. Heartbeat Output 18
1.3.3. DDS Output 19
Continuous mode 19
Artisan Technology Group - Quality Instrumentation ... Guaranteed | (888) 88-SOURCE | www.artisantg.com

Fractional mode 19
Divider Source 19
Divider Mode 20
Multiplier Mode 20
1.3.4. Time Coincidence Strobe Output 21
1.3.5. PCI(e) Interrupts 21
1.3.6. Additional Timing Output Signals 21
1.3.7. AM Time Code Calibration 21
1.3.8. Calibration Procedure 22
1.3.9. Field Upgrade of Embedded Program 23
1.4. Device Registers 26
1.4.1. General 26
1.4.2. PCI Memory Map 26
1.4.3. Device Register Description 26
TFP Device Register Summary 27
TIMEREQ Register (0x00) 27
EVENTREQ Register (0x04) 27
UNLOCK1 Register (0x08) 28
UNLOCK2 Register (0x0C) 28
CONTROL Register (0x10) 28
CONTROL Register 29
ACK Register (0x14) 30
MASK Register (0x18) 31
INTSTAT Register (0x1C) 31
INTSTAT Register 31
MINSTRB (0x20) – MAJSTRB (0x24) Registers 31
Artisan Technology Group - Quality Instrumentation ... Guaranteed | (888) 88-SOURCE | www.artisantg.com

EVENT2_0 (0x28) – EVENT2_1 (0x2C) Registers 32
TIME0 (0x30) - TIME1 (0x34) Registers 32
EVENT0 (0x38) - EVENT1 (0x3C) Registers 32
UNLOCK3 Register (0x44) 32
EVENT3_0 (0x48) – EVENT3_1 (0x4C) Registers 32
1.4.4. TIME FORMAT 32
STATUS BITS 34
Status Bits Summary 35
STATUS: Tracking (Bit 24) 35
STATUS: Phase (Bit 25) 35
STATUS: Frequency Offset (Bit 26) 35
1.5. Dual-Port RAM Interface 35
1.5.1. General 36
Input Area 36
Output Area 36
GPS Area 36
Year Area 36
DPRAM Address and Contents 36
1.5.2. ACK Register 36
ACK Bit 0 37
ACK Bit 2 37
ACK Bit 7 37
1.5.3. TFP DPRAM Commands 37
DPRAM Command Summary 40
Command 0x10: Set TFP Timing Mode 41
Command 0x11: Set Time Register Format 41
Artisan Technology Group - Quality Instrumentation ... Guaranteed | (888) 88-SOURCE | www.artisantg.com

Command 0x12: Set Major Time 42
Command 0x13: Set Year 42
Command 0x14: Set Periodic Output 43
Command 0x15: Set Input Time Code Format 43
Command 0x16: Set Input Time Code Modulation Type 44
Command 0x17: Set Propagation Delay Compensation 44
Command 0x18: Request UTC Time Data (bc637 only) 45
Command 0x19: Request TFP Data 45
Command 0x1A: Software Reset 46
Command 0x1B: Set Time Code Output Format 46
Command 0x1C: Set Generator Time Offset 48
Command 0x1D: Set Local Time Offset 49
Command 0x1E: Program Leap Second Event 49
Command 0x1F: Request Firmware Information 49
Command 0x20: Select Clock Source 50
Command 0x21: Control Jamsync 50
Command 0x22: Force Jamsync 50
Command 0x24: Load DAC 51
Command 0x25: Set Disciplining Gain 51
Command 0x26: Request Battery Connection Status 51
Command 0x27: Synchronize RTC to External Time Data 52
Command 0x28: RTC Battery Connection Control 52
Command 0x30: Send Packet to GPS Receiver (bc637 only) 52
Command 0x31: Request Packet from GPS Receiver (bc637 only) 52
Command 0x32: Manually Request Packet from GPS Receiver (bc637 only) 52
Command 0x33: Set GPS Time Format (bc637 only) 52
Artisan Technology Group - Quality Instrumentation ... Guaranteed | (888) 88-SOURCE | www.artisantg.com

Command 0x40: Observe Local Time Flag 53
Command 0x41: IEEE 1344 Daylight Saving and Local Time Flags 53
Command 0x43: Select Periodic or DDS Output 54
Command 0x44: Periodic or DDS Output Enable 54
Command 0x45: DDS Divide Select 54
Command 0x46: DDS Divide Source 55
Command 0x47: DDS Synchronization Mode Select 55
Command 0x48: DDS Multiplier Value 56
Command 0x49: DDS Period Value 56
Command 0x4A: DDS Tuning Word 56
Command 0x4F: PCI Firmware Part Number (request only) 57
Command 0xF6: TFP Model Identification (request only) 57
Command 0xFE: TFP Serial Number (request only) 58
1.6. Inputs and Outputs 58
1.6.1. TFP I/O ConnectorSignals 58
1.6.2. bc635PCIe and bc637PCIe Accessories 59
Signal Breakout Kit 59
Breakout Cables 61
Timing Input/Output Breakout cable and Patch Panel BNC Map 63
1.7. GPS Receiver Interface 63
1.7.1. General 63
1.7.2. GPS Timing Mode (Mode 6) Characteristics 64
1.7.3. Communicating With the GPS Receiver 64
Sending GPS Data Packets to the GPS Receiver 64
Receiving GPS Data Packets from the GPS Receiver 65
Retrieve Packet from GPS Receiver (Command 0x31) 65
Artisan Technology Group - Quality Instrumentation ... Guaranteed | (888) 88-SOURCE | www.artisantg.com

Manually Request Packet from GPS Receiver (Command 0x32) 67
1.7.4. Position Fix Modes 68
Position Fix Mode 0 68
Position Fix Mode 1 68
Position Fix Mode 3 and 4 68
1.8.5. GPS Default Parameters 68
Set Operating Parameters (GPS packet 0x2C) 69
Set High-8 / High-6 Mode (GPS packet 0x75) 69
Set I/O Options (GPS packet 0x35) 69
1.9. Legacy and New Generation Cards 69
1.9.1. PCI Bar Mapping 70
1.9.2. Differences Between Versions -U and New Generation Cards 70
2. Windows Application Programs 72
2.1. bc635PCIcfg.exe Windows Application Program 72
2.1.1. General 72
2.1.2. Quickstart Guide to Operating bc635PCIcfg.exe 72
2.1.3. bc637PCIcfg Program Menu Interface 74
File Menu 74
Time Menu 75
Time Code Menu 78
Signals Menu 79
Hardware Menu 81
Special Menu 82
PCI Menu 85
Help Menu 86
2.2. bc637PCIcfg.exe Windows Application Program 87
Artisan Technology Group - Quality Instrumentation ... Guaranteed | (888) 88-SOURCE | www.artisantg.com

2.2.1. General 87
2.2.2. Quickstart Guide to Operating bc637PCIcfg.exe 87
2.2.3. bc637PCIcfg.exe Program Menu Interface 88
File Menu 88
Time Menu 90
Status Menu 91
Mode Menu 91
Position Menu 92
Options Menu 92
Request Menu 93
Send Menu 94
Reset Menu 95
Help Menu 96
2.3. Traytime Windows Application Program 97
2.3.1. Installation 97
2.3.2. Functionality 97
2.3.3. TrayTime Dialog Windows 98
Main Window 98
TrayTime Setup - Status Window 99
TrayTime Setup - Configuration Window 100
3. Windows SDK 101
3.1. Introduction 101
3.1.1. General 101
3.1.2. Features 101
3.1.3. Overview 101
3.2. Release Notes 102
Artisan Technology Group - Quality Instrumentation ... Guaranteed | (888) 88-SOURCE | www.artisantg.com

Driver 102
Installation 102
Driver Packages 103
64-Bit Applications 103
DLL File 103
Software Developers Kit 103
TrayTime.exe 103
API Calling Convention 104
NoSync Read Time Functions 104
3.3. Installation 104
Hardware and driver installation 104
Software developer's kit installation 104
Configuration 105
Test installation 105
Project creation 105
Microsoft Visual C++ 6.0 105
Microsoft Visual Studio 2008 106
3.4. Library definitions 106
General 106
Windows SDK Command Finder 107
Functions 109
4. Linux SDK 139
4.1. Introduction 139
4.1.1. General 139
4.1.2. Features 139
4.1.3. Overview 139
Artisan Technology Group - Quality Instrumentation ... Guaranteed | (888) 88-SOURCE | www.artisantg.com

4.2. Installation 140
4.2.1. Hardware installation 140
4.2.2. Software installation 140
4.2.3. Linux kernel versions supported 142
4.2.4. Test Installation 142
4.2.5. Using the bc63xPCIcfg.exe program 143
Select Operational Mode 144
Request Time Settings 145
Select Timecode Decoding Format 146
Request Timecode Settings 146
Select Timecode Output Format 147
Select the Time Register Format 148
Read Current Time 149
Set Current Time 150
Set Current Year 150
Request Model Information 152
DDS Frequency and New Time Codes 152
Compatibility with Old bc635PCI or bc637PCI Card 155
Uninstall Instructions 155
4.3. Library Definitions 155
4.3.1. General 155
4.3.2. Functions 156
4.4. Programming Examples 186
4.4.1. General 186
4.4.2. Starting and Stopping the Device 186
4.4.3. Reading Time On Demand 187
Artisan Technology Group - Quality Instrumentation ... Guaranteed | (888) 88-SOURCE | www.artisantg.com

Reading in Binary Time Format 187
Reading in Decimal Time Format 188
3.4.4. Setting theTFP Mode 188
4.4.5. Setting Interrupts 188
5. Solaris SDK 191
5.1. Introduction 191
5.1.1. General 191
5.1.2. Features 191
5.1.3. Overview 191
5.2. Installation 191
5.2.1. Hardware Installation 191
5.2.2. Software Installation 192
5.2.3. Test Installation 196
5.2.4. Driver Compilation 197
5.3. Driver Function Definitions 199
5.3.1. General 199
5.3.2. Functions 199
5.4. Example Program 207
5.4.1. General 207
5.4.2. Program Functions 208
4.4.3. Example 1: GPS Packet 46 - Health Packet Sample 217
4.4.4. Example 2: 1PPS Interrupt Sample 217
Glossary 219
Index 222
Artisan Technology Group - Quality Instrumentation ... Guaranteed | (888) 88-SOURCE | www.artisantg.com

Artisan Technology Group - Quality Instrumentation ... Guaranteed | (888) 88-SOURCE | www.artisantg.com

1. PCI/PCIe TFP Hardware
1.1. Introduction
1.1.1. General Information
The Symmetricom model bc635PCI-V2, bc637PCI-V2, bc635PCIe, and bc637PCIe Time and
Frequency Processors (TFP) are high performance plug-in cards used for precise time syn-
chronization of the host computer over the PCI or PCIe bus.
Note that these Time and Frequency Processors will be referred as “TFP” or “TFPs” for the remainder
of the document.
The PCI TFP cards operate at 33 MHz and are compatible with PCI Local Bus Specification Revision
2.3. The PCI products support both the 3.3V and 5V signaling environments defined by the PCI Local
Bus Specification. They are considered Universal add-in cards that are capable of detecting the sig-
naling environment and adapting themselves to that environment.
The PCIe TFP cards offer similar features to the PCI cards. The PCIe cards use a single lane and
support full 2.5 Gbps in either direction.
The TFP products may be used in either Generator mode or Synchronized Generator mode, supplying
precise time (100's nanoseconds through thousands of years) to the host computer. When the card is
operating as a Synchronized Generator, the output signals are synchronized to the timing reference.
The card phase locks to the timing reference and controls the on-board oscillator to remove frequency
errors. If the timing reference is lost, the card continues to increment time and output timing signals
based upon the card's 10 MHz oscillator frequency (flywheeling).
There are eight separate TFP products supported by this manual:
Model Description
1 bc635PCI-V2 PCI Time & Frequency Processor with TCXO
2 bc637PCI-V2 GPS Synchronized, PCI Time & Frequency Processor with TCXO
3 bc635PCI-V2-OCXO PCI Time & Frequency Processor with OCXO
4 bc637PCI-V2-OCXO GPS Synchronized, PCI Time & Frequency Processor with OCXO
5 bc635PCIe PCI Express Time & Frequency Processor with TCXO
6 bc637PCIe GPSSynchronized, PCI Express Time & Frequency Processor with TCXO
7 bc635PCIe-OCXO PCI Express Time & Frequency Processor with OCXO
8 bc637PCIe-OCXO GPSSynchronized, PCI Express Time & Frequency Processor with OCXO
- 1 -
Artisan Technology Group - Quality Instrumentation ... Guaranteed | (888) 88-SOURCE | www.artisantg.com

1. PCI/PCIe TFP Hardware
Images of bc635PCI-V2 and bc635PCIe follow
Figure 1-1: Model bc635PCI-V2 Time and Frequency Processor
GPS Antenna A: SMB Antenna Connector
B: J1 Module I/O 15 pin D-sub connector
Figure 1-2: Model bc637PCI-V2 (GPS option shown with GPS antenna)
All sections of this manual are applicable to all boards except where noted.
- 2 -
Artisan Technology Group - Quality Instrumentation ... Guaranteed | (888) 88-SOURCE | www.artisantg.com

1.1. Introduction
Images of bc635PCI-V2 and bc635PCIe follow::
Figure 1-3: Model bc635PCIe Time and Frequency Processor
GPS Antenna
P/N 142-614-50
A: SMB Antenna Connector
B: J1 Module I/O 15 pin D-sub connector
Figure 1-4: Model bc637PCIe (GPS option shown with GPS antenna)
All sections of this manual are applicable to all boards except where noted.
- 3 -
Artisan Technology Group - Quality Instrumentation ... Guaranteed | (888) 88-SOURCE | www.artisantg.com