Difference between revisions of "MCE firmware"

From MCEWiki
(Source code and version-control system)
 
(260 intermediate revisions by 12 users not shown)
Line 1: Line 1:
* [[ MCE Firmware Catalog ]]
+
{{Related|Firmware}}
 +
== Releases ==
 +
All firmware can be downloaded from [http://e-mode.phas.ubc.ca/mce/firmware/ http://e-mode.phas.ubc.ca/mce/firmware/]. Release notes for each firmware release can be found below:
 +
* [[ Clock Card firmware]]
 +
* [[ Readout Card firmware]]
 +
* [[ Bias Card firmware]]
 +
* [[ Address Card firmware]]
 +
* [[ PCI card firmware ]]
 +
* [[ Sync Box Firmware ]]
  
* [[ MCE Untested features ]]
+
See also:
 +
* [[Recommended firmware versions]]
  
* [[ MCE bugs ]]
+
== Loading firmware onto cards ==
  
* [[ Using Ethernet Blaster ]]
+
There are two ways to load MCE firmware:
 +
# [[ Remote Firmware Update | Remote firmware update over the MCE fibre interface]]
 +
# Using Altera-supplied Hardware/Software and MCE Front-panel Connector
 +
#* [[ USB Blaster | step-by-step instructions ]]
  
== Feature descriptions ==
+
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'''''
  
* [[ Flux jumping ]]
+
== Implementation Details ==
* [[ Raw-mode readout ]]
 
  
== Procedures for keeping DAS/MCE healthy during firmware upgrades, power cycles, etc. ==
+
* Source on GitHub: https://github.com/multi-channel-electronics/mce_firmware
 +
* [[ MCE Timing Diagram ]]
 +
* [[MCE fibre protocol]] - communication between the MCE and the controlling PC over the fibre-optic link
 +
* [[MCE backplane protocol]] - communication between cards within the MCE
 +
* Monitoring MCE Status [[http://www.phas.ubc.ca/%7Emce/mcedocs/system/monitoring_mce_status.doc DOC]] (Nov. 9, 2006)
 +
* [[MCE commands]]
  
It is good practice to do a resetmce and a resetpci after any firmware upgrades or power cycles.  This is basically to clear out communications channels that may acquire garbage during these operations.
+
== Firmware Development Tools ==
 +
* [[ Quartus II Installation ]]
 +
* [[ ModelSim SE Installation ]]
 +
** [[ Setting up Altera libraries in ModelSim SE ]]
 +
* [[ JAM Player ]]
 +
* [[ Convert sof to jic for EPCS64 Serial Configuration Device ]]
  
Currently the PCI firmware does not clear its fibre fifo on reset.  This means that if there are fewer than 32 bits of garbage in the fifo, it doesn't get cleared until a valid reply from the MCE arrives.  As a result, we may expect the first MCE command following power up to fail some of the time.  Part of the power-up procedure should be to issue a command, then clear_fifo_mce_reply.  After this, the PCI should be in a stable state.
+
== Development notes ==
 +
* [[intmce:MCE bugs]]
 +
* [[intmce:Firmware Features Under Development]]
 +
* [[intmce:Closed firmware features]]
  
MFH plans to resolve this issue in PCI firmware version U.1.4.
+
[[Category:Firmware]]
 
 
== Source code and version-control system ==
 
 
 
We are migrating from CVS to SVN.
 
 
 
* [[ Firmware Accessing the svn repository | Accessing the svn repository ]]
 
* [[ Firmware svn commit guidelines | svn commit guidelines ]]
 
* svn basic operations
 
** [[ Firmware svn tagging | tagging ]]
 
** [[ Firmware svn merging | merging ]]
 
** [[ Firmware svn branching | branching ]]
 
** [[ Firmware svn undelete | resurrecting deleted items ]]
 

Latest revision as of 14:29, 31 January 2025

Related topics:

Releases

All firmware can be downloaded from http://e-mode.phas.ubc.ca/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