Pattern unification & Matterhorn Changes (#1303)

* update ctb regDefs, included fill level of adc, transceiver and DBit fifos, added enable registers for cont. readout

* fix fifo fill level range bug

* updated ctb RegDefs, increased size of fifo fill level register

* added register to read the firmware git hash

* ctb: added altchip_id read register

* start with unification of pattern machinery for xctb, ctb, mythen

* udate addrs for d-server internal matterhorn startup

* update xctb reg defs

* move pattern loopdef start

* added zero trimbits to matterhorn config

* Revert "added zero trimbits to matterhorn config"

This reverts commit 7c347badd5.

* added adjustable clocks on Xilinx-CTB

* added support for fractional dividers of runclk

* XCTB: make frequencies adjustable from python gui

* update docs

* added support for patternstart command to XCTB

* XCTB: map pattern_ram directly into memory, removed rw strobe

* refactor Mythen pattern control addresses

* test altera ctb with common addresses, removed ifdefs

* change ordering of regdefs

* updated python help for dbitclk, adcclk and runclk (khz)

* xilinx: moved the wait for firmware to measure the actual frequency to the server side and removed it in the pyctbgui side

* will not be anymore in developer branch

* make format (exception RegisterDefs.h), rewrite XILINX PLL to have less consstants in the code

* bug: mixing && for &

---------

Co-authored-by: Martin Mueller <martin.mueller@psi.ch>
Co-authored-by: Dhanya Thattil <dhanya.thattil@psi.ch>

slsDetectorSoftware/generator/commands.yaml

@@ -1272,7 +1272,7 @@ asamples:
       function: setNumberOfAnalogSamples
 
 adcclk:
-  help: "[n_clk in MHz]\n\t[Ctb] ADC clock frequency in MHz."
+  help: "[n_clk in MHz]\n\t[Ctb] ADC clock frequency in MHz.\n\t[xilinx Ctb] ADC clock frequency in kHz."
   inherit_actions: INTEGER_COMMAND_VEC_ID
   actions:
     GET:
@@ -1281,7 +1281,7 @@ adcclk:
       function: setADCClock
 
 runclk:
-  help: "[n_clk in MHz]\n\t[Ctb] Run clock in MHz."
+  help: "[n_clk in MHz]\n\t[Ctb] Run clock in MHz.\n\t[xilinx Ctb] Run clock in kHz."
   inherit_actions: INTEGER_COMMAND_VEC_ID
   actions:
     GET:
@@ -1318,7 +1318,7 @@ romode:
       input_types: [ defs::readoutMode ]
 
 dbitclk:
-  help: "[n_clk in MHz]\n\t[Ctb] Clock for latching the digital bits in MHz."
+  help: "[n_clk in MHz]\n\t[Ctb] Clock for latching the digital bits in MHz.\n\t[xilinx Ctb] Clock for latching the digital bits in kHz."
   inherit_actions: INTEGER_COMMAND_VEC_ID
   actions:
     GET:
@@ -1791,7 +1791,7 @@ defaultpattern:
 
 patternstart:
   inherit_actions: EXECUTE_SET_COMMAND
-  help: "\n\t[Mythen3] Starts Pattern"
+  help: "\n\t[Mythen3][Xilinx Ctb] Starts Pattern"
   actions:
     PUT:
       function: startPattern

slsDetectorSoftware/generator/extended_commands.yaml

@@ -106,7 +106,8 @@ adcclk:
         store_result_in_t: false
   command_name: adcclk
   function_alias: adcclk
-  help: "[n_clk in MHz]\n\t[Ctb] ADC clock frequency in MHz."
+  help: "[n_clk in MHz]\n\t[Ctb] ADC clock frequency in MHz.\n\t[xilinx Ctb] ADC clock\
+    \ frequency in kHz."
   infer_action: true
   template: true
 adcenable:
@@ -2219,7 +2220,8 @@ dbitclk:
         store_result_in_t: false
   command_name: dbitclk
   function_alias: dbitclk
-  help: "[n_clk in MHz]\n\t[Ctb] Clock for latching the digital bits in MHz."
+  help: "[n_clk in MHz]\n\t[Ctb] Clock for latching the digital bits in MHz.\n\t[xilinx\
+    \ Ctb] Clock for latching the digital bits in kHz."
   infer_action: true
   template: true
 dbitphase:
@@ -6515,7 +6517,7 @@ patternstart:
         store_result_in_t: false
   command_name: patternstart
   function_alias: patternstart
-  help: "\n\t[Mythen3] Starts Pattern"
+  help: "\n\t[Mythen3][Xilinx Ctb] Starts Pattern"
   infer_action: true
   template: true
 patwait:
@@ -8133,7 +8135,7 @@ runclk:
         store_result_in_t: false
   command_name: runclk
   function_alias: runclk
-  help: "[n_clk in MHz]\n\t[Ctb] Run clock in MHz."
+  help: "[n_clk in MHz]\n\t[Ctb] Run clock in MHz.\n\t[xilinx Ctb] Run clock in kHz."
   infer_action: true
   template: true
 runtime:

slsDetectorSoftware/include/sls/Detector.h

@@ -1612,16 +1612,16 @@ class Detector {
     /** [CTB] */
     void setNumberOfAnalogSamples(int value, Positions pos = {});
 
-    /** [CTB] */
+    /** [CTB] in MHz, [XCTB] in kHz */
     Result<int> getADCClock(Positions pos = {}) const;
 
-    /** [CTB] */
+    /** [CTB] in MHz, [XCTB] in kHz */
     void setADCClock(int value_in_MHz, Positions pos = {});
 
-    /** [CTB] */
+    /** [CTB] in MHz, [XCTB] in kHz */
     Result<int> getRUNClock(Positions pos = {}) const;
 
-    /** [CTB] */
+    /** [CTB] in MHz, [XCTB] in kHz */
     void setRUNClock(int value_in_MHz, Positions pos = {});
 
     /** [CTB]  in MHZ */
@@ -1691,10 +1691,10 @@ class Detector {
      */
     void setReadoutMode(defs::readoutMode value, Positions pos = {});
 
-    /** [CTB] */
+    /** [CTB] in MHz, [XCTB] in kHz */
     Result<int> getDBITClock(Positions pos = {}) const;
 
-    /** [CTB] */
+    /** [CTB] in MHz, [XCTB] in kHz */
     void setDBITClock(int value_in_MHz, Positions pos = {});
 
     /**
@@ -1943,7 +1943,7 @@ class Detector {
      * selected bits */
     void setPatternBitMask(uint64_t mask, Positions pos = {});
 
-    /** [Mythen3] */
+    /** [Mythen3][Xilinx CTB] */
     void startPattern(Positions pos = {});
     ///@}
 

slsDetectorSoftware/src/Caller.cpp

@@ -73,7 +73,8 @@ std::string Caller::adcclk(int action) {
     // print help
     if (action == slsDetectorDefs::HELP_ACTION) {
         os << R"V0G0N([n_clk in MHz]
-	[Ctb] ADC clock frequency in MHz. )V0G0N"
+	[Ctb] ADC clock frequency in MHz.
+	[xilinx Ctb] ADC clock frequency in kHz. )V0G0N"
            << std::endl;
         return os.str();
     }
@@ -2805,7 +2806,8 @@ std::string Caller::dbitclk(int action) {
     // print help
     if (action == slsDetectorDefs::HELP_ACTION) {
         os << R"V0G0N([n_clk in MHz]
-	[Ctb] Clock for latching the digital bits in MHz. )V0G0N"
+	[Ctb] Clock for latching the digital bits in MHz.
+	[xilinx Ctb] Clock for latching the digital bits in kHz. )V0G0N"
            << std::endl;
         return os.str();
     }
@@ -8452,7 +8454,7 @@ std::string Caller::patternstart(int action) {
     // print help
     if (action == slsDetectorDefs::HELP_ACTION) {
         os << R"V0G0N(
-	[Mythen3] Starts Pattern )V0G0N"
+	[Mythen3][Xilinx Ctb] Starts Pattern )V0G0N"
            << std::endl;
         return os.str();
     }
@@ -10429,7 +10431,8 @@ std::string Caller::runclk(int action) {
     // print help
     if (action == slsDetectorDefs::HELP_ACTION) {
         os << R"V0G0N([n_clk in MHz]
-	[Ctb] Run clock in MHz. )V0G0N"
+	[Ctb] Run clock in MHz.
+	[xilinx Ctb] Run clock in kHz. )V0G0N"
            << std::endl;
         return os.str();
     }