AMC13CppSoftware < BUCMSPublic

Tags: view all tags
---+++ AMC13 Tool Acquisition and Installation

This software is OBSOLETE.    Please see [[AMC13CppProductionSoftware]] for
information on the new software.


Current code is in the HCAL xDAQ SVN:  [[https://svnweb.cern.ch/cern/wsvn/cmshcos][here]].
Follow links to trunk/hcalUpgrade/amc13/src/common (sorry!)

| *Contents* | 
| [[#SoftwareForUseWithXdaq][Software for use with xDAQ]] | 
| [[#SoftwareForUseWithoutXdaq][Software for use without xDAQ]] |
| [[#AdditionalLinks][Additional AMC13 Software Links]] |

#SoftwareForUseWithXdaq
---++ Software for use with xDAQ
If HCAL xDAQ is installed on your SLC5 machine, and if you have access to the CMS HCAL repository, then you should follow the instructions below to get the latest software for the HCAL Upgrade uTCA electronics.  These build notes are based on Jeremy's instructions, as found in the hypernews email that accompanies the latest xDAQ release.  

---+++ Installation Instructions
The instructions below use release number 11_5_2 as an example.  Substitute in the latest release number to get the most up-to-date software.

To install on a teststand (as daqowner) :
   1. Log onto your machine as daqowner using =ssh= or switch to the daqowner user by doing =$ su daqowner=.  You will need to know the password for daqowner on your machine.
   1. Get the code from the online repository
      * =$ wget !http://cmshcalweb01.cern.ch/hcalsw/release/installDAQ_11_5_2.perl=
   1. Install the release
      * =$ perl installDAQ_11_5_2.perl --mode=teststand=
   1. You will need to pick the most recent release by setting the =~daqowner/dist= symlink
      * =$ ~daqowner/common/bin/pickRelease.sh=
      * Choose the most recent release, which is, in this case, 11_5_2
   1. Lastly, you will need to set the environment before using the software
      * =$ ~daqowner/dist/etc/env.csh= or =$ ~daqowner/dist/etc/env.csh=
      * In the above command, use =.csh= if you are running a t-shell or =.sh= if you are running a bash shell
   1. Now you should be able to use the software!  To check, try running AMC13Tool.  You will need to set your AMC13 serial number as an environment variable first.
      * For t-shell, do: =$ setenv AMC13_SERIAL_NO 9=
      * For bash, do: =$ export AMC13_SERIAL_NO=9=
      * Now you can run the executable: =$ !AMC13Tool.exe=

#SoftwareForUseWithoutXdaq
---++ Software for use without xDAQ

Below are the releases of the standalone, non-xDAQ C++ software for the AMC13.  This software requires a [[CactusInstallation][CACTUS installation]] on the host machine.  If you have installed CACTUS on SLC5 via YUM or via an RPM build, please use the software under the *Software for an RPM Build* header.  If you are using SL5 or any other OS and installed CACTUS manually (via a checkout of the code from SVN), then use the software under the *Software for a Manual Build* header.

---+++ Software for an RPM Build
   * [[http://ohm.bu.edu/~dzou/amc13Releases/amc13StandaloneRPM_2014-07-17.tar.gz][amc13StandaloneRPM_2014_07-17.tar.gz]] - new release. Fixed software to check for address table for address of monitor buffer (For captability w/ new firmware)
   * [[http://ohm.bu.edu/~dzou/amc13Releases/amc13StandaloneRPM_2014-05-12.tar.gz][amc13StandaloneRPM_2014_05-12.tar.gz]] - new release. Updated amc13Config scripts with several bug fixes
   * [[http://ohm.bu.edu/~dzou/amc13Releases/amc13StandaloneRPM_04-07-2014.tar.gz][amc13StandaloneRPM_04-07-2014.tar.gz]] - new release. Fixed bug to write backup spartan (golden) flash on lx45t chips. Also, changed code to accept mcs files w/ prefix 'amc13' in lowercase as well as 'AMC13'
   * [[http://ohm.bu.edu/~dzou/amc13Releases/amc13StandaloneRPM_03-26-2014.tar.gz][amc13StandaloneRPM_03-26-2014.tar.gz]] - new release. Added feature to AMC13Tool flash programming/verifying which matches the correctly sized Spartan MCS based on SN
   * [[http://ohm.bu.edu/~dzou/amc13Releases/amc13StandaloneRPM_03-14-2014.tar.gz][amc13StandaloneRPM_03-14-2014.tar.gz]] - special release for compatibility w/ uhal2.2 using ipbus 2.0 core firmware. using -bigendian protocol URI. Do not use otherwise
   * [[http://ohm.bu.edu/~dzou/amc13Releases/amc13StandaloneRPM_08-20-2013.tar.gz][amc13StandaloneRPM_08-20-2013.tar.gz]] - new release. Minor Bug fix in production test and in AMC13Tool
   * [[http://buphy.bu.edu/~dzou/amc13Releases/amc13StandaloneRPM_06-03-2013.tar.gz][amc13StandaloneRPM_06-03-2013.tar.gz]] - new release. Added command to read T2 temp and voltages
   * [[http://buphy.bu.edu/~dzou/amc13Releases/amc13StandaloneRPM_05-30-2013.tar.gz][amc13StandaloneRPM_05-30-2013.tar.gz]] - new release. Bug Fixes
   * [[http://ohm.bu.edu/~chill90/amc13_standalone/amc13StandaloneRPM_05-16-2013.tar.gz][amc13StandaloneRPM_05-16-2013.tar.gz]] - new release. Software work-arounds for IPbus bugs and added MMC configuration scripts 
   * [[http://ohm.bu.edu/~chill90/amc13_standalone/amc13StandaloneRPM_05-13-2013.tar.gz][amc13StandaloneRPM_05-13-2013.tar.gz]] - new release. Added options for locating the AMC13 and disabling ControlHub
   * [[http://ohm.bu.edu/~chill90/amc13_standalone/amc13StandaloneRPM_04-16-2013.tar.gz][amc13StandaloneRPM_04-16-2013.tar.gz]] - new release. Includes new class organization. Functionality unchanged.
   * [[http://ohm.bu.edu/~chill90/amc13_standalone/amc13StandaloneRPM_2013_01_31.tar.gz][amc13StandaloneRPM_2013_01_31.tar.gz]] - new release. Includes configurable prescaling, TTC port enable, various bug fixes, and newest firmware
   * [[http://ohm.bu.edu/~chill90/amc13_standalone/amc13StandaloneRPM_2012_12_04.tar.gz][amc13StandaloneRPM_2012_12_04.tar.gz]] - initial release. Includes DAQ link and internal TTC capabilities


---+++ Software for a Manual Build
   * [[http://ohm.bu.edu/~dzou/amc13Releases/amc13StandaloneMAN_2014-07-17.tar.gz][amc13StandaloneMAN_2014_07-17.tar.gz]] - new release. Fixed software to check for address table for address of monitor buffer (For captability w/ new firmware)
   * [[http://ohm.bu.edu/~dzou/amc13Releases/amc13StandaloneMAN_2014-05-12.tar.gz][amc13StandaloneMAN_2014_05-12.tar.gz]] - new release. Updated amc13Config scripts with several bug fixes
   * [[http://ohm.bu.edu/~dzou/amc13Releases/amc13StandaloneMAN_04-07-2014.tar.gz][amc13StandaloneMAN_04-07-2014.tar.gz]] - new release. Fixed bug to write backup spartan (golden) flash on lx45t chips. Also, changed code to accept mcs files w/ prefix 'amc13' in lowercase as well as 'AMC13'
   * [[http://ohm.bu.edu/~dzou/amc13Releases/amc13StandaloneMAN_03-26-2014.tar.gz][amc13StandaloneMAN_03-26-2014.tar.gz]] - new release. Added feature to AMC13Tool flash programming/verifying which matches the correctly sized Spartan MCS based on SN
   * [[http://ohm.bu.edu/~dzou/amc13Releases/amc13StandaloneMAN_03-14-2014.tar.gz][amc13StandaloneMAN_03-14-2014.tar.gz]] - special release for compatibility w/ uhal2.2 using ipbus 2.0 core firmware. using -bigendian protocol URI. Do not use otherwise
   * [[http://ohm.bu.edu/~dzou/amc13Releases/amc13StandaloneMAN_08-15-2013.tar.gz][amc13StandaloneMAN_08-15-2013.tar.gz]] - new release. Minor Bug fix in production test and in AMC13Tool
   * [[http://buphy.bu.edu/~dzou/amc13Releases/amc13StandaloneMAN_06-03-2013.tar.gz][amc13StandaloneMAN_06-03-2013.tar.gz]] - new release. Added command to read T2 temp and voltages
   * [[http://buphy.bu.edu/~dzou/amc13Releases/amc13StandaloneMAN_05-30-2013.tar.gz][amc13StandaloneMAN_05-30-2013.tar.gz]] - new release. Bug Fixes
   * [[http://ohm.bu.edu/~chill90/amc13_standalone/amc13StandaloneMAN_05-16-2013.tar.gz][amc13StandaloneMAN_05-16-2013.tar.gz]] - new release. Software work-arounds for IPbus bugs and added MMC configuration scripts
   * [[http://ohm.bu.edu/~chill90/amc13_standalone/amc13StandaloneMAN_05-13-2013.tar.gz][amc13StandaloneMAN_05-13-2013.tar.gz]] - new release. Added options for locating the AMC13 and disabling ControlHub
   * [[http://ohm.bu.edu/~chill90/amc13_standalone/amc13StandaloneMAN_04-16-2013.tar.gz][amc13StandaloneMAN_04-16-2013.tar.gz]] - new release. Includes new class organization. Functionality unchanged.
   * [[http://ohm.bu.edu/~chill90/amc13_standalone/amc13StandaloneMAN_2013_01_31.tar.gz][amc13StandaloneMAN_2013_01_31.tar.gz]] - new release. Includes configurable prescaling, TTC port enable, various bug fixes, and newest firmware
   * [[http://ohm.bu.edu/~chill90/amc13_standalone/amc13StandaloneMAN_2012_12_04.tar.gz][amc13StandaloneMAN_2012_12_04.tar.gz]] - initial release. Includes DAQ link and internal TTC capabilities

---+++ Installation Instructions

   * These instructions are presented as for an RPM build installation, but are identical for a non-RPM build installation

   1. Go the the directory in which you want to install the software on your machine.  Then, use *wget* to download the software using the proper link above.  For instance:
   <verbatim>
   wget  http://ohm.bu.edu/~chill90/amc13_standalone/amc13StandaloneRPM_2012_12_04.tar.gz
   </verbatim>
   1. Unpack the tarball like so:
   <verbatim>
   tar -zxvf amc13StandaloneRPM_2012_12_04.tar.gz
   </verbatim>
   This will create a folder which holds all of the software.  You can rename the folder and move it to where you wish.
   1. Go into the newly created folder and set the environment using the *.csh* script if you are running a t-shell, or *.sh* if you are running a bash shell.  For instance:
   <verbatim>
   cd amc13StandaloneRPM_2012_12_04/
   source uhalEnv.sh
   </verbatim>
   1. Now you are ready to build the code.  From the same directory (the one with the Makefile in it), do:
   <verbatim>
    make
   </verbatim>
   1. Once the code is done building, you are ready to run AMC13Tool.  Make sure to set the environment variable =AMC13_SERIAL_NO= to your AMC13's serial number (found in permenant ink on the front panel of the module).  For instance, in the following example, I am preparing to use serial number 9:
   <verbatim>
   export AMC13_SERIAL_NO=9
   ./bin/AMC13Tool -u
   </verbatim>
   * You can find [[AMC13Tool][detailed documentation]] on all of the commands and [[AMC13ToolRecipes][common procedures]] via the first page of =amc13.info=.  This page will give you instructions on how to update your firmware, enable the AMC13, control the interal TTC signal, take data, etc.  

#AdditionalLinks
---++ AMC13 Software Links
| *Additional Links* |
| [[CppClass][AMC13 C++ Classes]] |
| [[AMC13CppSoftwareBuildNotes][How to install a xDAQ release]] |
| [[AMC13xDAQConfiguration][AMC13 xDAQ Configuration Variables]] |
| [[AMC13Tool][AMC13Tool Specification]] |
| [[AMC13ToolGettingStarted][Getting started with AMC13Tool]] |
| [[AMC13ToolRecipes][AMC13Tool Recipes]] |



-- Main.CharlieHill - 04 Dec 2012
Topic revision: r26 - 12 Mar 2015 - EricHazen