MCE firmware
From MCEWiki
Contents
[hide]Critical Notes
- 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
- 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 from http://e-mode.phas.ubc.ca/mce_firmware/. Release notes for each firmware release can be found below:
- Clock Card (CC)
- Readout Card (RC)
- Bias Card (BC)
- Address Card (AC)
- Power-Supply Unit Controller (PSUC)
- Sync Box Firmware
Firmware Upgrade Methods
There are two ways to upgrade the MCE firmware:
- Remote firmware update over the MCE fibre interface
- Using Altera-supplied Hardware/Software and MCE Front-panel Connector
MCE Features and How-To Guides
- Data 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 Modes
- Filtered Data & the Digital 4-pole Butterworth Low-pass Filter
- Raw 50 MHz Data
- Flux Jumping
- FSFB Clamping Commands -- to prevent unlocked pixels from ramping (RC v5.0.a+)
- FSFB Servo Start Value
- 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
- Firmware Documentation
- Upgrading From 4.x.x To 5.x.x Firmware -- using SCUBA-2 as an example
MCE Firmware Bugs/ Features Under Development has been moved to the intmce:MCE bugs.
Firmware Development Tools
- Firmware CVS repository
- Quartus II Installation
- ModelSim SE Installation
- Firmware CVS Repository
- MCE RTL Testbenches
- JAM Player
- JRunner
- Convert sof to jic for EPCS64 Serial Configuration Device
MCE Scripting
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)
- 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
- Power-Supply Unit Controller:
- PSUC Firmware Description [PDF] (SC2-ELE-S585-xxx)
- SyncBox
- Stratix FPGA Configuration [PDF] (SC2-ELE-S500-021) (ATC)
- Clock Card [PDF] (SC2-ELE-S563-200) (ATC) (Jun. 05, 2003)
- Clock Card Boot [PDF] (SC2-ELE-S563-201) (ATC) (Jun. 05, 2003)
