EDT HRC User Manual

User’s Guide

HRC

Mezzanine Board

High Rate Carrier (E4, STS3, OC3 / STM1)
for use with a PCI / PCIe Main Board

Doc. 008-02006-03a
Rev. 2013 January 22

Contact

Sky Blue Microsystems GmbH

Geisenhausenerstr. 18
81379 Munich, Germany
[phone], [e-mail]

www.skyblue.de

In Great Britain:

Zerif Technologies Ltd.

H5 Ash Tree Court
Nottingham NG8 6PY, England
[phone], [e-mail]
www.zerif.co.uk



TM

EDT

and Engineering Design TeamTM are trademarks of Engineering Design Team, Inc. All other trademarks, service marks,

and copyrights are the property of their respective owners†.

© 1997-2013 Engineering Design Team, Inc. All rights reserved.

Contact

Sky Blue Microsystems GmbH

Geisenhausenerstr. 18
81379 Munich, Germany
[phone], [e-mail]

www.skyblue.de

EDT, Inc. 2

In Great Britain:

Zerif Technologies Ltd.

H5 Ash Tree Court
Nottingham NG8 6PY, England
[phone], [e-mail]
www.zerif.co.uk

Terms of Use Agreement

Definitions. This agreement, between Engineering Design Team, Inc. (“Seller”) and the user or distributor (“Buyer”), covers the

use and distribution of the following items provided by Seller: a) the binary and all provided source code fo r any and all device
drivers, software libraries, utilities, and example applications (collectively, “Software”); b) the binary and all provided source code
for any and all configurable or programmable devices (collectively, “Firmware”); and c) the computer boards and all other physical
components (collectively, “Hardware”). Software, Firmware, and Hardware are collectively referred to as “Products.” This
agreement also covers Seller’s published Limited Warranty (“Warranty”) and all other published manuals and product information
in physical, electronic, or any other form (“Documentation”).

License. Seller grants Buyer the right to use or distribute Seller’s Software and Firmware Products solely to enable Seller’s
Hardware Products. Seller’s Software and Firmware must be used on the same computer as Seller’s Hardware. Seller’s Products
and Documentation are furnished under, and may be used only in accordance with, the terms of this agreement. By using or
distributing Seller’s Products and Documentation, Buyer agrees to the terms of this agreement, as well as any additional
agreements (such as a nondisclosure agreement) between Buyer and Seller.

Export Restrictions. Buyer will not permit Seller’s Software, Firmware, or Hardware to be sent to, or used in, any other country
except in compliance with applicable U.S. laws and regulations. For clarification or advice on such laws and regulations, Buyer
should contact: U.S. Department of Commerce, Export Division, Washington, D.C., U.S.A.

Limitation of Rights. Seller grants Buyer a royalty-free right to modify, reproduce, and distribute executable files using the
Seller’s Software and Firmware, provided that: a) the source code and executable files will be used only with Seller’s Hardware;
b) Buyer agrees to indemnify, hold harmless, and defend Seller from and against any claims or lawsuits, including attorneys’ fees,
that arise or result from the use or distribution of Buyer’s products containing Seller’s Products. Seller’s Hardware may not be
copied or recreated in any form or by any means without Seller’s express written consent.

No Liability for Consequential Damages. In no event will Seller, its directors, officers, employees, or agents be liable to Buyer
for any consequential, incidental, or indirect damages (including damages for business interruptions, loss of business profits or
information, and the like) arising out of the use or inability to use the Products, even if Seller has been advised of the possibility
of such damages. Because some jurisdictions do not allow the exclusion or limitation of liability for consequential or incidental
damages, the above limitations may not apply to Buyer. Seller’s liability to Buyer for actual damages for any cause whatsoever,
and regardless of the form of the action (whether in contract, product liability, tort including negligence, or otherwise) will be
limited to fifty U.S. dollars ($50.00).

Limited Hardware Warranty. Seller warrants that the Hardware it manufactures and sells shall be free of defects in materials
and workmanship for a period of 12 months from date of shipment to initial Buyer. This warranty does not apply to any product
that is misused, abused, repaired, or otherwise modified by Buyer or others. Seller’s sole obligation for breach of this warranty
shall be to repair or replace (F.O.B. Seller’s plant, Beaverton, Oregon, USA) any goods that are found to be non-conforming or
defective as specified by Buyer within 30 days of discovery of any defect. Buyer shall bear all installation and transportation
expenses, and all other incidental expenses and damages.

Limitation of Liability. In no event shall Seller be liable for any type of special consequential, incidental, or penal damages,
whether such damages arise from, or are a result of, breach of contract, warranty, tort (including negligence), strict liability, or
otherwise. All references to damages herein shall include, but not be limited to: loss of profit or revenue; loss of use of the goods

or associated equipment; costs of substitute goods, equipment, or facilities; downtime costs; or claims for damages. Seller shall
not be liable for any loss, claim, expense, or damage caused by, contributed to, or arising out of the acts or omissions of Buyer,
whether negligent or otherwise.

No Other Warranties. Seller makes no other warranties, express or implied, including without limitation the implied warranties
of merchantability and fitness for a particular purpose, regard ing Seller’s Products or Documentation. Seller does not warrant,
guarantee, or make any representations regarding the use or the results of the use of the Products or Documentation or their
correctness, accuracy, reliability, currentness, or otherwise. All risk related to the results and performance of the Products and
Documentation is assumed by Buyer. The exclusion of implied warranties is not permitted by some jurisdictions. The above
exclusion may not apply to Buyer.

Disclaimer. Seller’s Products and Documentation, including this document, are subject to change without notice. Documentation
does not represent a commitment from Seller.

EDT, Inc. 3

Contents

Overview................................................................................................................................................................... 5

DMA: Four-channel vs. Legacy Sixteen-channel......................................................................................... 5

FPGAs on the PCI / PCIe Main Board......................................................................................................... 5

Companion Products.................................................................................................................................... 6

Related Resources....................................................................................................................................... 6

Installation................................................................................................................................................................. 7

About the Software and Firmware................................................................................................................ 7

The PCD Device Driver................................................................................................................................ 7

FPGA Configuration Files ................................................................. ... ... ... ... .... ........................................... 8

Software Initialization Files........................................................................................................................... 8

Sample Applications and Utilities................................................................................................................. 8

Sample Applications.............................................................................................................................. 9

Utility Files............................................................................................................................................. 9

Basic Testing Files ................................................................................................................................ 9

Building or Rebuilding an Application........................................................................................................... 9

Configuring the HRC............................................................................................................................................... 10

Checking or Updating the PCI / PCIe FPGA Firmware.............................................................................. 10

Loading the UI FPGA Firmware and Configuring the HRC........................................................................ 11

Using Custom FPGA Configuration Files................................................................................................... 11

Configuring the Channels ....................................................................................................................................... 11

Basic Testing .......................................................................................................................................................... 11

Connector Pinout .......... ... ... ... .... ... ....................................... ... ... ... .... ... ... ... .... ... ...................................................... 12

Registers................................................................................................................................................................. 13

Revision Log .......... .... ... ... ... ... .... ...................................... .... ... ... ... .... ... ................................................................... 19

EDT, Inc. 4

HRC Mezzanine Board

Overview

The HRC Mezzanine Board supports OC3 / STM1, STS3, or E4 signals in various combinations, including

framing and descrambling for OC3 / STM1 framed data. The board allows DMA output at the rate of 139 or

155 Mb/s (DMA is provided through the PCI / PCIe Main Board). The PCI / PCIe interface has bandwidth to

output OC3 / STM1 data on all four HRC channels.

The HRC has four connector locations; each is occupied by either a 75- BNC coaxial interface with CMI-

coded transmission, or a fiber-optic LC with a single-mode 1300 nm transceiver.

The standard connector combinations are: 4 BNC; 4 fiber-optic; 2 of each; or 3 BNC + 1 fiber-optic. Each

BNC can be programmed for either input or output; for bidirectional coaxial operation, a maximum of two

channels is available. The fiber-optic HRC has eight potential data streams (four in and four out), so full

duplex operation on all four fiber ports is not possible.

DMA: Four-channel vs. Legacy Sixteen-channel

Due to the constant filling and flushing of the DMA data pipeline in the host computer, some computers

cannot support the PCI bandwidth required for more than two active HRC outputs. With 16-channel DMA,

DMA burst size is smaller, and the PCI bus cannot switch between channels fast enough. With four-chann el

operation, however, DMA occurs in bigger bursts, with less switching — a more efficient mode of operation.

Therefore, we recommend that you configure new systems for four-channel operation.

However, if you choose to use sixteen-channel operation, you can do so by using the UI FPGA configuration

file

sshrcin.bit, the software initialization file hrcin.cfg, and a PCI FPGA configuration file ending in

...16.bit

available DMA channels (four in and four out), assuming that you have written you r own firmware to do so.

The DMA channels correlate to the HRC inputs and outputs as follows:

Channel 0 = input 0 Channel 2 = input 2 Channel 4 = output 0 Channel 6 = output 2

Channel 1 = input 1 Channel 3 = input 3 Channel 5 = output 1 Channel 7 = output 3

(either pciss16.bit or pcigs16.bit). Thus configured, the HRC can use eight of the sixteen

FPGAs on the PCI / PCIe Main Board

The HRC is paired with an EDT PCI / PCIe Main Board, which has the following FPGAs:

•The user interface (UI) FPGA links the HRC to the main board’s PCI or PCIe FPGA.

•The PCI or PCIe FPGA communicates with the host computer over the PCI or PCIe bus and implements
the DMA engine, which transfers data between the board and the host. This FPGA loads automatically,
at powerup, with the correct firmware from the main board’s FPGA configuration flash memory (“flash
memory”).

For details, consult the PCI / PCIe Main Board User’s Guide (see Related Resources below).

EDT, Inc. 2013 January 22 5

HRC Overview

Companion Products

For additional resources, the HRC is designed to work with these EDT products:

• Required – a PCI / PCIe Main Board (PCI SS, PCI GS, or PCIe8 LX / FX), for DMA and other resources

• Optional – a Time Distribution Board, for precise timestamping of the data.

For details on these products, see Related Resources.

Related Resources

The resources below may be helpful or necessary for your applications.

EDT Resources
Description Detail Web link

• HRC specifications Datasheet (on product page) www.edt.com

• PCI / PCIe Main Board information Datasheet and user’s guide www.edt.com/main_boards.html

• Time Distribution board information Datasheet and user’s guide www.edt.com/timedist.html

• Application Programming Interface HTML and PDF versions www.edt.com/manuals.html

• Installation packages: 

Windows, Linux, Solaris, Mac

Software / firmware
downloads

www.edt.com/software.html

EDT, Inc. 2013 January 22 6