Merge pull request #123 from DUNE-DAQ/feature/timing_source_mux

Feature/timing source mux

config/etc/addrtab/v7xx/kerberos_mib_v2/pdts_mib_v2_io.xml

@@ -15,9 +15,10 @@
 					<node id="sfp0_los" mask="0x8"/>
 					<node id="sfp1_los" mask="0x10"/>        	
 					<node id="sfp2_los" mask="0x20"/>
-					<node id="pll_lol" mask="0x40"/>
-					<node id="mmcm_ok" mask="0x80"/>
-					<node id="mmcm_sticky" mask="0x100"/>
+					<node id="pll_ok" mask="0x40"/>
+					<node id="pll_sticky" mask="0x80"/>
+					<node id="mmcm_ok" mask="0x100"/>
+					<node id="mmcm_sticky" mask="0x200"/>
 				</node>
 		</node>
 		<node id="config" address="0x2" description="board/firmware config" fwinfo="endpoint;width=1">

config/etc/addrtab/v7xx/kerberos_mib_v2/pdts_timing_source_mux.xml

@@ -1,7 +1,7 @@
 <node id="pdts_timing_source_mux" description="Switch between upstream timing sources" fwinfo="endpoint">
 		<node id="csr" address="0x0" fwinfo="endpoint;width=0">
 			<node id="ctrl" address="0x0">
-				<node id="src" mask="0x1"/>
+				<node id="src" mask="0x3"/>
 			</node>
 		</node>
 </node>

include/timing/BoreasDesign.hpp

@@ -47,7 +47,7 @@ class BoreasDesign : public MasterDesign, public HSIDesignInterface
    * @brief      Prepare the timing master for data taking.
    *
    */
-  void configure() const override;
+  void configure(ClockSource clock_source, TimestampSource ts_source) const override;
 
   /**
    * @brief    Give info to collector.

include/timing/ChronosDesign.hpp

@@ -15,7 +15,7 @@
 // Timing Headers
 #include "timing/HSINode.hpp"
 #include "timing/HSIDesignInterface.hpp"
-#include "timing/EndpointDesign.hpp"
+#include "timing/TopDesign.hpp"
 
 // uHal Headers
 #include "uhal/DerivedNode.hpp"
@@ -47,7 +47,7 @@ class ChronosDesign : public TopDesign, public HSIDesignInterface
    * @brief      Prepare the timing endpoint for data taking.
    *
    */
-  void configure() const override;
+  void configure(ClockSource clock_source) const override;
 
   /**
    * @brief      Read endpoint firmware version.

include/timing/EndpointDesign.hpp

@@ -44,12 +44,6 @@ class EndpointDesign : public TopDesign, public EndpointDesignInterface
    */
   std::string get_status(bool print_out = false) const override;
 
-  /**
-   * @brief      Prepare the timing endpoint for data taking.
-   *
-   */
-  void configure() const override;
-
   // /**
   //  * @brief    Give info to collector.
   //  */  
@@ -68,6 +62,12 @@ class EndpointDesign : public TopDesign, public EndpointDesignInterface
    */
   void validate_firmware_version() const override;
 
+  /**
+   * @brief      Prepare the timing endpoint for data taking.
+   *
+   */
+  void configure(ClockSource clock_source) const override;
+
   /**
    * @brief    Give info to collector.
    */

include/timing/FIBIONode.hpp

@@ -113,6 +113,11 @@ class FIBIONode : public SFPMuxIONode {
      */
     void switch_sfp_tx(uint32_t sfp_id, bool turn_on) const override; // NOLINT(build/unsigned)
 
+    /**
+     * @brief     Clocks ready?
+     */
+    bool clocks_ok() const override;
+
     // /**
     // * @brief      Fill hardware monitoring structure.
     // */

include/timing/FIBV2IONode.hpp

@@ -71,6 +71,11 @@ class FIBV2IONode : public IONode {
      */
     void switch_sfp_tx(uint32_t sfp_id, bool turn_on) const override; // NOLINT(build/unsigned)
 
+    /**
+     * @brief     Clocks ready?
+     */
+    bool clocks_ok() const override {return true;} //TODO measure clock freq.
+
     /**
       * @brief      Print status of on-board PLL.
       */

include/timing/FMCIONode.hpp

@@ -69,6 +69,11 @@ class FMCIONode : public IONode
     */
   std::string get_clock_frequencies_table(bool print_out = false) const override;
 
+  /**
+   * @brief     Clocks ready?
+   */
+  bool clocks_ok() const override;
+
   /**
    * @brief      control tx laser of on-board SFP
    */

include/timing/FanoutDesign.hpp

@@ -54,15 +54,15 @@ class FanoutDesign : public TopDesign, public EndpointDesignInterface, public CD
    * @brief      Prepare the timing fanout for data taking.
    *
    */
-  void configure() const override;
+  void configure(ClockSource clock_source) const override;
 
   /**
    * @brief      Validate endpoint firmware version.
    *
    */
-  void validate_firmware_version() const override { /*firmware version in fanout design right now*/}
+  void validate_firmware_version() const override;
 
-  uint32_t read_firmware_version() const override { /*firmware version in fanout design right now*/}
+  uint32_t read_firmware_version() const override;
 
   /**
    * @brief    Give info to collector.

include/timing/GIBIONode.hpp

@@ -67,7 +67,7 @@ class GIBIONode : public IONode
   /**
    * @brief     Reset timing node with clock file lookup
    */
-  void reset(const ClockSource& clock_source) const override;
+  using IONode::reset;
 
   /**
    * @brief      Print status of on-board SFP.
@@ -79,6 +79,11 @@ class GIBIONode : public IONode
    */
   void switch_sfp_soft_tx_control_bit(uint32_t sfp_id, bool turn_on) const override; // NOLINT(build/unsigned)
 
+  /**
+   * @brief     Clocks ready?
+   */
+  bool clocks_ok() const override;
+
   /**
    * @brief      control tx laser of on-board SFP softly (I2C command)
    */

include/timing/GaiaDesign.hpp

@@ -51,10 +51,10 @@ class GaiaDesign : public MasterDesign, public EndpointDesignInterface, public C
   // void get_info(opmonlib::InfoCollector& ci, int level) const override;
 
   /**
-   * @brief      Prepare the timing fanout for data taking.
+   * @brief      Prepare the timing unit for data taking.
    *
    */
-  void configure() const override;
+  void configure(ClockSource clock_source, TimestampSource ts_source, IRIGEpoch epoch) const;
 
   /**
    * @brief    Give info to collector.

include/timing/IONode.hpp

@@ -178,6 +178,11 @@ class IONode : public TimingNode
    */
   virtual void reset(const ClockSource& clock_source) const;
 
+  /**
+   * @brief     Clocks ready?
+   */
+  virtual bool clocks_ok() const = 0;
+
   virtual void get_info(timinghardwareinfo::TimingPLLMonitorData& mon_data) const {get_pll()->get_info(mon_data);}
 
   static const std::map<BoardType, std::string>& get_board_type_map() { return board_type_map; }