Difference between revisions of "MCE firmware"

From MCEWiki
Line 21: Line 21:
 
* 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'''''
 
* 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'''''
  
 
+
Special cases:
== MCE Features and How-To Guides ==
 
* [[ MCE Commands ]]
 
* [[MCE Timing Diagram | MCE (Firmware) Timing Diagram]]
 
* [[ Row-specific SQ2FB (fast switching)]]
 
 
 
* Data Acquisition
 
** [[ 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
 
** [[ Data mode | Data Modes ]]
 
** [[ Digital 4-pole Butterworth Low-pass filter | Filtered Data & the Digital 4-pole Butterworth Low-pass Filter]]
 
** [[ Raw-mode readout | Raw 50 MHz Data ]]
 
** [[ Flux jumping | Flux Jumping]]
 
** [[ FSFB Clamping Commands ]] -- to prevent unlocked pixels from ramping (RC v5.0.a+)
 
** [[ FSFB Servo Start Value ]]
 
 
 
* Address Card
 
** [[ Fast SQ2 Feedback and TES Biasing with an Address Card ]]
 
** [[ Special SQ1 Bias Commands ]]
 
 
 
* 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 ]]
 
 
 
 
* [[ Upgrading From 4.x.x To 5.x.x Firmware ]] -- using SCUBA-2 as an example
 
* [[ Upgrading From 4.x.x To 5.x.x Firmware ]] -- using SCUBA-2 as an example
  
Line 67: Line 36:
 
* [[ JRunner ]]
 
* [[ JRunner ]]
 
* [[ Convert sof to jic for EPCS64 Serial Configuration Device ]]
 
* [[ Convert sof to jic for EPCS64 Serial Configuration Device ]]
 
== MCE Scripting ==
 
* [[ MAS ]]
 
* [[ MAS Cheat Sheet ]]
 
* [[ Using Python to Automate MAS ]]
 
* [[ MCE: Helper programs ]]
 
  
 
== Old documents ==
 
== Old documents ==

Revision as of 18:17, 11 January 2012

Template:Hierarchy header

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:

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

Special cases:

MCE Firmware Bugs/ Features Under Development has been moved to the intmce:MCE bugs.

Firmware Development Tools

Old documents

  • Loading FPGA Firmware Using EthernetBlaster TXT
  • Loading PSUC Microcontroller Firmware Using Atmel FLIP [PDF]
  • Firmware Overview [PDF] (SC2-ELE-S500-023) (ATC) (Jun. 06, 2003)
  • Address Card:
    • top-level [DOC] (Oct. 06, 2005)
    • ac_dac_ctrl [DOC]
  • Bias Card:
    • top-level [DOC] (Oct. 06, 2005)
  • Readout Card:
    • top-level [DOC] (SC2-ELE-S582-201) (Oct. 05, 2005)
    • flux_loop [DOC] (SC2-ELE-S582-202) (Sep. 15, 2004)
    • adc_sample_coadd [DOC] (SC2-ELE-S582-204) (Feb. 15, 2004)
    • fsfb_calc [DOC] (SC2-ELE-S582-205) (Feb. 09, 2006)
    • Low-Pass Filtering [PDF] (SC2-ELE-S582-211) (Jul. 28, 2006)
    • fsfb_calculations_diagram (SC2-ELE-S582-011) [PDF]
    • fsfb_ctrl [DOC] (SC2-ELE-S582-206) (Feb. 15, 2005)
    • offset_sa_bias_ctrl (SC2-ELE-S582-207) [DOC] (Apr. 04, 2005)
    • wbs_fb_data (SC2-ELE-S582-209) [DOC] (Feb. 15, 2005)
    • wbs_frame_data [DOC] (SC2-ELE-S582-210) (Feb. 15, 2005)
    • fsfb_corr (flux_jumping) [DOC] (Oct. 07, 2005)
    • Servo-Loop Diagram (SC2-ELE-S582-012) [DOC]
  • Blocks common to RC, AC, CC, BC
    • dispatch [DOC] (SC2-ELE-S580-202) (Oct. 31, 2005)
      • lvds_rx [DOC] (Oct. 3, 2005)
      • lvds_tx[DOC] (Nov. 2004)
  • Power-Supply Unit Controller:
    • PSUC Firmware Description [PDF] (SC2-ELE-S585-xxx)
  • SyncBox
    • SyncBox CPLD Firmware Description [PDF] (SC2-ELE-S589-201)
    • SyncBox Microcontroller Software Description [PDF] (SC2-ELE-S589-202)

(Old MCE Firmware Documents index)