Adding tips

a038da6c · Dave Newbold · 866d31ad · a038da6c · a038da6c
Commit a038da6c authored Apr 17, 2018 by Dave Newbold
Hide whitespace changes
Inline Side-by-side

Showing with 60 additions and 1 deletion

sc_zs_sel_rolling.vhd components/solid/firmware/hdl/sc_zs_sel_rolling.vhd +1 -1

startup_tips.txt projects/timing/doc/startup_tips.txt +59 -0

No files found.
--- a/components/solid/firmware/hdl/sc_zs_sel_rolling.vhd
+++ b/components/solid/firmware/hdl/sc_zs_sel_rolling.vhd
@@ -61,7 +61,7 @@ begin
 		end if;
 	end process;
 	
-- Select highest ZS threshold of active triggers
+-- Select highest-numbered ZS threshold of active triggers

 	process(cnt)
 		variable t, k: unsigned(1 downto 0);

--- a/projects/timing/doc/startup_tips.txt
+++ b/projects/timing/doc/startup_tips.txt
+Startup procedure step 1 (from cold start, i.e power-on)
+
+    Timing board (master first, then slaves)
+        - Reset registers (csr.ctrl.soft_rst)
+        - Set board layer (csr.ctrl.layer)
+        - Reset PLL (csr.ctrl.pll_rst)
+        - Program PLL
+            - Different program for layer 0 and layer 1 boards
+        - Check frequency (freq_ctr)
+        
+    Planes
+        - Reset registers (csr.ctrl.soft_rst)
+        - Disable MMCM (set csr.ctrl.rst_mmcm)
+        - Reset idelayctrl (csr.ctrl.rst_idelayctrl)
+        - Check that idelayctrl is locked (csr.stat.idelayctrl_rdy)
+        - Reset PLL (io.csr.ctrl.clkgen_rst)
+        - Program PLL
+        - Check for PLL lock (io.csr.stat.clkgen_lol)
+        - Check frequency (io.freq_ctr)
+        - Enable MMCM (unset csr.ctrl.rst_mmcm)
+        - Check MMCM lock (csr.stat.mmcm_locked)
+        - {Do setup for channels, triggers, thresholds, sequencer, etc}
+        
+Startup procedure step 2 (from warm start, or following step 1)
+
+    Planes
+        - Enable external sync (set daq.timing.csr.ctrl.en_ext_sync)
+        - Enable pipeline (set daq.timing.csr.ctrl.pipeline_en)
+        - Enable readout buffer (set daq.roc.csr.ctrl.en)
+        
+    Timing board (master)
+        - Issue the sync (set sync_ctrl.en_sync)
+        
+    Planes
+        - {do all the board-by-board trigger link enabling stuff, and check status}
+        
+Starting a run
+
+    Planes
+        - {Enable triggers}
+
+Stopping a run
+
+    Planes
+        - {Disable triggers}
+        - {Wait for buffers to empty}
+        
+Shutdown procedure step 1
+
+    Planes
+        - Disable pipeline (unset daq.timing.csr.ctrl.pipeline_en)
+        - Disable buffer (unset daq.roc.csr.ctrl.en)
+
+[At this point, you can change settings and re-start from startup procedure step 2]
+
+Shutdown procedure step 2 (if you really want to start over without power cycling)
+        
+    All boards
+        - Nuke the suckers (csr.ctrl.nuke for timing, csr.ctrl.nuke for planes)