HME Clear-Com EclipseHX Installation and operation manual

Upgrade Guide
PN: 399G058 Rev: A 08/22/13

Document Reference
Clear-Com Eclipse HX Upgrade Guide
Product number: 399G058 Revision: A
Legal Disclaimers
Copyright © 2013 HME Clear-Com Ltd.
All rights reserved.
Clear-Com, the Clear-Com logo, and Clear-Com Concert are trademarks or registered
trademarks of HM Electronics, Inc.
The software described in this document is furnished under a license agreement and may be
used only in accordance with the terms of the agreement.
The product described in this document is distributed under licenses restricting its use, copying,
distribution, and decompilation/reverse engineering. No part of this document may be
reproduced in any form by any means without prior written authorization of Clear-Com, an HME
Company.
Clear-Com Offices are located in California, USA; Cambridge, UK; Montreal, Canada; and
Beijing, China. Specific addresses and contact information can be found on Clear-Com’s
corporate website:
www.clearcom.com
Clear-Com Contacts
Americas and Asia-Pacific Headquarters
California, United States
Tel: [phone]
Email: [e-mail]
Europe, Middle East, and Africa Headquarters
Cambridge, United Kingdom
Tel: [phone]
Email: SalesSupportEME[email protected]
Canada Office
Quebec, Canada
Tel: [phone]
China Office
Beijing Representative Office
Beijing, P.R.China
Tel: [phone]
2 Eclipse HX Upgrade Guide

Contents
1Important Safety Instructions................................................................... 1
Safety symbols..........................................................................................................................2
Mains power cord......................................................................................................................2
2Introduction................................................................................................ 1
2.1 Planning the upgrade to Eclipse HX...............................................................................1
2.1.1 Client / Server installations......................................................................................2
2.1.2 Roll back strategy....................................................................................................2
2.1.3 Supplied DVDs ........................................................................................................3
2.1.4 Fitting the Eclipse HX door panel............................................................................4
2.1.5 Help with upgrading.................................................................................................8
3Quick reference: Upgrading to Eclipse HX v7.1...................................... 9
3.1 Upgrading from 5.2.4......................................................................................................9
3.2 Upgrading from 7.0.......................................................................................................12
4Upgrading to Eclipse HX v7.1................................................................. 16
4.1 Backing up your ECS v5.2.4 configurations .................................................................16
4.2 Installing EHX ...............................................................................................................17
4.3 Importing your configurations into EHX........................................................................17
5Upgrading the CPU cards ....................................................................... 19
5.1 Changing the CPU card PROM....................................................................................19
5.2 Changing the CPU card RAM.......................................................................................20
5.3 Changing the CPU card DIP switches..........................................................................21
5.4 Upgrading the CPU card application code....................................................................22
5.4.1 Upgrading the CPU card application code using EHX with an Ethernet connection
22
5.4.2 Upgrading the CPU card application code with EHX using a serial link................24
5.4.3 Upgrading the CPU Card application code using Tera Term................................27
5.5 Setting the matrix type..................................................................................................32
5.6 Checking the CPU card application code version ........................................................33
5.7 Upgrading CPU Card U53 CPLD..................................................................................33
5.8 Upgrading CPU Card U1 CPLD....................................................................................35
5.9 Upgrading the CPU card U53 CPLD code with Xilinx tools..........................................36
5.10 Upgrading the CPU card U1 CPLD code with Xilinx tools......................................38
5.11 Downloading a test configuration to the CPU card using EHX...............................41
5.12 Forcing the CPU card to the factory default IP address..........................................41
6Upgrading the Eclipse HX-PiCo.............................................................. 42
6.1 Changing the Eclipse HX-PiCo PROM.........................................................................42
3 Eclipse HX Upgrade Guide

6.2 Changing the Eclipse HX-PiCo RAM............................................................................44
6.3 Changing the Eclipse HX-PiCo DIP switches...............................................................45
6.4 Upgrading the Eclipse HX-PiCo application code ........................................................46
6.4.1 Upgrading the Eclipse HX-PiCo application code using EHX with an Ethernet
connection...........................................................................................................................46
6.4.2 Upgrading the Eclipse HX-PiCo application code using EHX with a serial
connection...........................................................................................................................48
6.4.3 Upgrading the Eclipse HX-PiCo application code using Tera Term......................51
6.5 Upgrading the Eclipse HX-PiCo MVX code..................................................................57
6.5.1 Upgrading the Eclipse HX-PiCo MVX application code with EHX .......................58
6.5.2 Upgrading the Eclipse HX-PiCo MVX boot and/or application code using the
Renesas FDT ......................................................................................................................60
6.6 Checking the Eclipse HX-PiCo application code and MVX code versions...................65
6.7 Upgrading the Eclipse HX-PiCo CPLD and FPGA code with Xilinx tools ....................66
6.8 Download a test configuration into the Eclipse HX-PiCo using EHX............................69
6.9 Forcing the Eclipse HX-PiCo to the factory default IP address....................................69
7Upgrading the MVX-A16 card ................................................................. 71
7.1 Upgrading the MVX-A16 boot and/or application code ................................................71
7.1.1 Upgrading the MVX-A16 card application code using EHX..................................71
7.1.2 Upgrading the MVX-A16 card boot and application code using the Renesas FDT
73
7.2 Checking the MVX-A16 boot and application code version..........................................76
7.3 Upgrading the MVX-A16 card FPGA with Xilinx tools..................................................78
8Upgrading E-FIB cards............................................................................ 81
8.1 Upgrading E-FIB card FPGA with Xilinx tools ..............................................................81
9Upgrading E-QUE cards.......................................................................... 84
9.1 Identifying MK1 and MK2 E-QUE cards .......................................................................84
9.2 Upgrading the E-QUE card (MK1)................................................................................85
9.3 Upgrading the E-QUE card (MK2)................................................................................91
9.4 Upgrading the E-QUE card (MK1 and MK2) FPGA with Xilinx tools............................98
9.5 Upgrading the E-QUE card (MK1) boot ROM ............................................................100
9.6 Upgrading the E-QUE card (MK2) boot ROM ............................................................101
10 Upgrading IVC-32 and LMC-64 cards................................................. 107
10.1 Identifying MK1 and MK2 IVC-32 / LMC-64 cards................................................107
11 Upgrading E-MADI64 cards................................................................... 109
11.1 Upgrading the E-MADI64 boot code .....................................................................109
11.2 Upgrading the E-MADI64 application, DSP and FPGA code using EHX..............112
11.3 Upgrading the E-MADI64 FPGA using the Xilinx tool set .....................................115
4 Eclipse HX Upgrade Guide

12 Upgrading CellCom / FreeSpeak wireless systems.......................... 118
13 Upgrading panels .................................................................................. 119
13.1 Upgrading panels using EHX................................................................................119
13.1.1 Locating Panel *.fwp files on the software DVD............................................122
13.1.2 V-Series upgrades.........................................................................................122
13.2 Upgrading panel application code manually .........................................................123
13.2.1 Cabling for I-Series upgrades........................................................................123
13.2.2 Manually upgrading I-Series panel application code.....................................125
13.2.3 Manually upgrading E-Station application code............................................130
13.3 Manually upgrading V-Series panels.....................................................................134
13.3.1 Upgrading the V-Series Display Module .......................................................140
14 Upgrading the TEL-14 module.............................................................. 141
14.1 Upgrading the TEL-14 hardware...........................................................................141
14.2 Upgrading the TEL-14 firmware............................................................................143
15 Upgrading the AES-6 module ............................................................... 146
15.1.1 Upgrading AES-6 FPGA................................................................................148
Appendix A: CPU card layout ................................................................. 153
Appendix B: CPU card DIP switches...................................................... 154
Appendix C: Eclipse HX-PiCo CPU DIP switches.................................. 157
Appendix D: Hitachi Renesas Flash Development Tool....................... 159
Appendix E: TFTPUtil .............................................................................. 165
Appendix F: Tera Term............................................................................ 167
Appendix G: Flash Magic......................................................................... 169
Appendix H: I-Series converter cable wiring and rear panel layouts .. 172
Appendix I: Xilinx tools ............................................................................. 174
Appendix J: Clear-Com® End User Software License .......................... 175
5 Eclipse HX Upgrade Guide

1 Important Safety Instructions
1. Read these instructions.
2. Keep these instructions.
3. Heed all warnings.
4. Follow all instructions.
5. Do not use this apparatus near water.
6. Clean only with dry cloth.
7. Do not block any ventilation openings. Install in accordance with the manufacturer’s
instructions.
8. Do not install near any heat sources such as radiators, heat registers, stoves, or other
apparatus (including amplifiers) that produce heat.
9. Do not defeat the safety purpose of the polarized or grounding-type plug. A polarized
plug has two blades and a third grounding prong. The wide blade or the third prong are
provided for your safety. If the provided plug does not fit into your outlet, consult an
electrician for replacement of the obsolete outlet.
10. Protect the power cord from being walked on or pinched particularly at plugs,
convenience receptacles, and the point where they exit from the apparatus.
11. Only use attachments/accessories specified by the manufacturer.
12. Use only with the cart, stand, tripod, bracket, or table specified by the manufacturer, or
sold with the apparatus. When a cart is used, use caution when moving the
cart/apparatus combination to avoid injury from tip-over.
13. Unplug this apparatus during lightning storms or when unused for long periods of time.
14. Refer all servicing to qualified service personnel. Servicing is required when the
apparatus has been damaged in any way, such as power-cord supply or plug is
damaged, liquid has been spilled or objects have fallen into the apparatus, the
apparatus has been exposed to rain or moisture, does not operate normally, or has
been dropped.
15. Warning: To reduce the risk of fire or electric shock, do not expose this product to rain
or moisture.

Safety symbols
Familiarize yourself with the safety symbols in Figure 1 below. These symbols are displayed on
the apparatus and warn you of the potential danger of electric shock if the system is used
improperly. They also refer you to important operating and maintenance instructions in the
product user manual.
Figure 1: Safety symbols
Mains power cord
Eclipse HX matrices are powered by an internal power supply. The cord to connect the internal
power supply to the mains supply must conform to the following:
•The mains power cord shall have an IEC C13 connector at one end and a mains
power plug at the other end.
•An IEC C13 plug has three pins, the centre pin carrying the earth / ground. The other
two pins carry neutral and live circuits.
•The conductors of the mains cords shall have adequate cross-sectional area for rated
current consumption of the equipment.
•The mains plug that connects to the mains supply must be approved for use in the
country where the equipment is to be used.
•The mains power cord must be an IEC mains power cord complying with standard
IEC60320; IEC320/C13.
•Mains power cords used in the U.S. must also comply with standard UL817.
2 Eclipse HX Upgrade Guide

2 Introduction
This guide describes how to upgrade from ECS v5.2.4 to Eclipse HX v7.5, the third software
release for the Clear-Com Eclipse HX™digital matrix system (standalone or networked).This
guide additionally identifies the simpler upgrade from V7.0/7.1 to V7.5
The system components covered by the guide include (but are not limited to):
•Matrices (Eclipse HX-PiCo, Eclipse HX-Median, Eclipse HX-Delta and Eclipse HX-
Omega)
•Interface cards (E-FIB, E-QUE, MVX-A16, E-MADI64, LMC-64, and others)
•Interface modules (AES-6, TEL-14 and others)
•User panels (V-series and I-Series panels)
Important note:
Eclipse HX upgrades must be performed by a technically qualified engineer.
2.1 Planning the upgrade to Eclipse HX
Before you start upgrading your Eclipse (ECS v5.2.4) system components to Eclipse HX v7.5,
ensure that you have:
•Sufficient spare (replacement) cards, interfaces or panels for the upgrade.
•Scheduled enough time to complete the upgrade, or if required, roll back the
upgrade to the version that was running before the upgrade.
•A suitable backup system is in place to maintain service, if your intercom system is
part of a mission critical or sensitive application.
You should also be aware that:
•The order in which you carry out the upgrade is important. The chapters of this guide
are laid out in the order that your system components should be upgraded.
Tip: For a quick reference to the upgrade procedures you require, and the order in
which they should be carried out, see chapter 3 Quick reference: Upgrading to
Eclipse HX.
•If you are upgrading V-Series panels, you may have to upgrade each V-Series panel
individually by connecting it directly to a PC.

•Upgrading the matrices in a networked (linked) system should take place at the same
time, because the data sent between networked matrices can change.
When upgrading networked (linked) matrices, Clear-Com recommends that you:
•Upgrade only one CPU card in each matrix first and then perform the rest of
the system upgrade (interface cards, user panels, and so on) afterwards.
•Upgrade the remaining CPU cards in the matrices only when the upgrade has
been completed and tested across the full system. Leaving the remaining CPU
cards until last gives you the capability of quickly rolling back to the previously
running version, if any mission critical issues are encountered.
•Great care must be taken when opening the lid of the Eclipse HX-PiCo matrix to
upgrade components. This may invalidate UL status.
Remove power from the device first, to avoid working with the system
while it is live. Observe all electrical shock hazard warning and
precautions for handling electrostatic sensitive devices
2.1.1 Client / Server installations
When upgrading Client / Server installations from ECS v5.2.4 or EHX 7.0/7.1 to Eclipse HX
v7.5, you must::
•-Use the EHX 7.5 Server Installer only on the PC that is to be the EHX Server.
The Eclipse HX v7.5 server installer will automatically update your IIS and configure
it to work with Eclipse HX v7.5.
•-Use the standard EHX 7.5 Client Installer on all the Client PCs. The Server PC can
also act as a client.
You should check that you have the appropriate IIS and .Net Windows components installed
prior to installing the EHX Server. Please refer to the Initial Setup section of the Client/Server
chapter in the EHX User Guide for a complete list of the components required for each version
of Windows.
Note: Installing an EHX Server is an advanced workflow - please contact Clear-Com Support for
advice before attempting to install an EHX Server.
Before upgrading your EHX Server installation, Clear-Com strongly recommends that you
export any existing projects (using File->Export from an EHX Client) and backup your users list
(using the Export command in the User Management screen). It is recommended that you
uninstall your existing EHX Server before installing the newer version.
2.1.2 Roll back strategy
You should not encounter any mission critical issues when upgrading to Eclipse HX v7.5.
However, if you decide to roll back the system to the previously running version, then you must:
•Allow adequate time for the roll back operation.
•Roll back all system components to the same baseline version.
2 Eclipse HX Upgrade Guide

Temporary roll back strategy
If you want to roll back to the previously running version for a temporary period only, before
making another attempt to upgrade to Eclipse HX v7.5, then you may implement the following
temporary roll back strategy:
1. Leave all cards and panels at Eclipse HX v7.5.
2. Roll back the matrix CPU card to run at the previously running version.
3. Re-install the previous running version of ECS/EHX and import your old
configurations.
Caution:
The above strategy is a temporary solution only. Eclipse HX v7.5 configurations will not import
or work with a CPU card at ECS v5.2.4 or EHX v7.0/7.1. If you want to run the previously
running system software for an extended period, Clear-Com recommends rolling back all
system components to the same baseline version.
2.1.3 Supplied DVDs
Different DVD sets are supplied to the customer, according to the type of Eclipse HX product
that has been purchased:
Product Software/Documentation
DVD
Hardware DVD
Matrix -
ECS / EHX
-
Upgrade kit
Table 1: Supplied DVDs
Hardware DVD
The hardware DVD contains the latest firmware for your Eclipse HX devices, including Boot
PROM and FPGA / CPLD code files for Eclipse HX matrices, interface cards, interface modules
and supported panels (I-Series and V-Series panels). You must upgrade to the latest firmware
when upgrading to Eclipse HX v7.5.
The hardware DVD also includes the third party software that may be used during upgrades.
Note:
The separate and combined MVX boot and application code files (which are used to upgrade
the MVX code on both the Eclipse HX-PiCo and MVX-A16 card) are located on the software
DVD. The MVX FPGA code is located on the hardware DVD.
3 Eclipse HX Upgrade Guide