Difference between revisions of "MCE firmware"

From MCEWiki
(→‎Firmware Development Tools)
 
(60 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
= Critical Notes =
+
{{Related|Firmware}}
−
* In v5+ firmware, if you update firmware on any readout card, the card doesn't reply to any command unless the Clock Card is also reprogrammed.
+
== Releases ==
 +
Bitstream for all FPGA firmware revisions can be downloaded from [http://e-mode.phas.ubc.ca/mce/firmware/ http://e-mode.phas.ubc.ca/mce/firmware/].  
  
−
* Always cleanly reset the MCE after a power-up or a reconfiguration!  If not, MCE communication with the PC or Sync Box may not work.  On MAS prompt, type: '''''mce_reset_clean'''''
+
Source code for FPGA firmware and else available here https://github.com/multi-channel-electronics/mce_firmware
−
 
 
−
* After an mce_reset, not all of the DAC outputs are set to zero.  In addition, values written to RAM-based registers are not reset. A full reconfiguration is required for a proper reset. You may power-cycle the MCE remotely if the MCE is equipped with a PSA (UBC switching supply) by issuing '''''mce_cmd -x rs psc cycle_pow 1''''' and then '''''mce_reset_clean'''''
 
−
 
 
−
= Releases =
 
−
All firmware can be downloaded [http://www.phas.ubc.ca/~mce/mcedocs/firmware/ here]
 
  
 
Release notes for each firmware release can be found below:
 
Release notes for each firmware release can be found below:
−
* [[ Clock Card (CC) ]]
+
* [[ Clock Card firmware]]
−
* [[ Readout Card (RC) | Readout Card (RC) Rev. A/B]] (Stratix I)
+
* [[ Readout Card firmware]]
−
* [[ Readout Card (RC) Rev. C/D ]] (Stratix III)
+
* [[ Bias Card firmware]]
−
* [[ Bias Card (BC) ]]
+
* [[ Address Card firmware]]
−
* [[ Address Card (AC) ]]
+
* [[ PCI card firmware ]]
−
* [[ Power-Supply Unit Controller (PSUC) Rev. 1 ]]
 
−
* [[ Power-Supply Unit Controller (PSUC) Rev. 2 ]]
 
 
* [[ Sync Box Firmware ]]
 
* [[ Sync Box Firmware ]]
  
−
* [[ Compatible Versions (CC,RC,BC,AC) ]].  (Lists of versions of firmware to use together.)
+
See also:
 +
* [[Recommended firmware versions]]
  
−
= Firmware Upgrade Methods =
+
== Loading firmware onto cards ==
−
* Using Altera supplied Hardware/Software
 
−
** [[ USB Blaster ]]
 
−
** [[ Quartus II Installation ]]
 
−
** [[ Using Ethernet Blaster | Ethernet Blaster ]]
 
−
* Remote firmware update over the MCE fibre interface
 
−
** Firmware Downloads and .Jam-File Generation
 
−
** [[ Generating .JAM Files For Remote Update ]]
 
−
** [[ Sof2jam ]]  (bash script)
 
−
** [[ Generating .Jam-Files Manually ]]
 
  
−
= CVS Repository =
+
There are two ways to load MCE firmware:
−
* Ask the "MCE team at UBC" for a username/password to be able to access the repository
+
# [[ Remote Firmware Update | Remote firmware update over the MCE fibre interface]]
−
* Install a CVS client ( e.g. http://www.tortoisecvs.org/ )
+
# Using Altera-supplied Hardware/Software and MCE Front-panel Connector
−
* CVS server info is:
+
#* [[ USB Blaster | step-by-step instructions ]]
−
**server: e-mode.phas.ubc.ca
 
−
**repository folder:/home/cvsroot/mce
 
−
**module name: mce
 
−
**protocol: pserver
 
  
−
= MCE Features and How-To Guides =
+
Things to bear in mind:
−
* [[ MCE Commands ]]
+
* In v5+ firmware, if you update firmware on any readout card, the card doesn't reply to any command unless the Clock Card is also reprogrammed.
−
* [[ Upgrading From 4.x.x To 5.x.x Firmware ]] -- using SCUBA-2 as an example
+
* Always cleanly reset the MCE after a power-up or a reconfiguration!  If not, MCE communication with the PC or Sync Box may not work. On MAS prompt, type: '''''mce_reset_clean'''''
  
−
* Data Acquisition
+
== Implementation Details ==
−
** [[ High rate acquisition | Fast Data Acquisition ]] -- i.e. up to the frame rate
 
−
** [[ The STOP Command ]] (CC v4.0.b, v4.0.c, v5.0.1+)
 
−
** [[ How to Configure Which Readout Cards Report Data ]] (CC v4.0.a+)
 
−
** [[ How to Read a Column at the Frame Rate ]] (CC v5.0.0 & RC v5.0.0+)
 
−
** [[ Rectangle Mode Data ]] (CC v5.0.0 & RC v5.0.1+)
 
  
−
* Readout Card
+
* Source on GitHub: https://github.com/multi-channel-electronics/mce_firmware
−
** [[ Data mode | Data Modes ]]
+
* [[ MCE Timing Diagram ]]
−
** [[ Digital 4-pole Butterworth Low-pass filter | Filtered Data & the Digital 4-pole Butterworth Low-pass Filter]]
+
* [[MCE fibre protocol]] - communication between the MCE and the controlling PC over the fibre-optic link
−
** [[ Raw-mode readout | Raw 50 MHz Data ]]
+
* [[MCE backplane protocol]] - communication between cards within the MCE
−
** [[ Flux jumping | Flux Jumping]]
+
* Monitoring MCE Status [[http://www.phas.ubc.ca/%7Emce/mcedocs/system/monitoring_mce_status.doc DOC]] (Nov. 9, 2006)
−
** [[ FSFB Clamping Commands ]] -- to prevent unlocked pixels from ramping (RC v5.0.a+)
+
* [[MCE commands]]
−
** [[ FSFB Servo Start Value ]]
 
  
−
* Address Card
+
== Firmware Development Tools ==
−
** [[ Fast SQ2 Feedback and TES Biasing with an Address Card ]]
 
−
 
 
−
* Clock Card
 
−
** [[ Remote Firmware Update ]] (CC v5.0.7+)
 
−
** [[ Internal Commands ]]
 
−
*** [[ Arbitrary Waveform Generator ]] -- for maximum length sequences and complex impedance measurements (CC v5.0.3+)
 
−
*** [[ Ramp Generator ]]
 
−
*** [[ Temperature monitoring ]]
 
−
 
 
−
MCE Firmware Bugs/ Features Under Development has been moved to the [http://e-mode.phas.ubc.ca/intmcewiki/index.php/MCE_bugs Internal MCE Wiki Bug List].
 
−
 
 
−
= Firmware Development Tools =
 
 
* [[ Quartus II Installation ]]
 
* [[ Quartus II Installation ]]
 
* [[ ModelSim SE Installation ]]
 
* [[ ModelSim SE Installation ]]
−
* [[MCE_firmware#CVS_Repository|Firmware CVS Repository]]
+
** [[ Setting up Altera libraries in ModelSim SE ]]
−
* [[MCE RTL Testbenches]]
 
 
* [[ JAM Player ]]
 
* [[ JAM Player ]]
−
* [[ JRunner ]]
+
* [[ Convert sof to jic for EPCS64 Serial Configuration Device ]]
 +
 
 +
== Development notes ==
 +
* [[intmce:MCE bugs]]
 +
* [[intmce:Firmware Features Under Development]]
 +
* [[intmce:Closed firmware features]]
  
−
= MCE Scripting =
+
[[Category:Firmware]]
−
* [[ http://e-mode.phas.ubc.ca/mcewiki/index.php/MAS MAS ]]
 
−
* [[ MAS Cheat Sheet ]]
 
−
* [[ Using Python to Automate MAS ]]
 
−
* [[ MCE: Helper programs ]]
 

Latest revision as of 08:52, 8 April 2025

Related topics:
▼ Firmware‎ (7 C, 4 P)
► Address Card Firmware‎ (10 P)
► Bias Card Firmware‎ (9 P)
► Clock Card Firmware‎ (17 P)
► Communication‎ (2 C, 1 P)
► Development Tools‎ (11 P)
► Readout Card Firmware‎ (17 P)
► Sync Box Firmware‎ (3 P)
  CVS Diff Between rc v0400000c and sys v05000000
  MCE firmware
  MCE usage
  Programming over Fibre

Releases

Bitstream for all FPGA firmware revisions can be downloaded from http://e-mode.phas.ubc.ca/mce/firmware/.

Source code for FPGA firmware and else available here https://github.com/multi-channel-electronics/mce_firmware

Release notes for each firmware release can be found below:

See also:

Loading firmware onto cards

There are two ways to load MCE firmware:

  1. Remote firmware update over the MCE fibre interface
  2. Using Altera-supplied Hardware/Software and MCE Front-panel Connector

Things to bear in mind:

  • In v5+ firmware, if you update firmware on any readout card, the card doesn't reply to any command unless the Clock Card is also reprogrammed.
  • Always cleanly reset the MCE after a power-up or a reconfiguration! If not, MCE communication with the PC or Sync Box may not work. On MAS prompt, type: mce_reset_clean

Implementation Details

Firmware Development Tools

Development notes

Retrieved from "https://e-mode.phas.ubc.ca/mcewiki/index.php?title=MCE_firmware&oldid=7871"