RMMClocks.h

#pragma once
 
#include <chrono>
#include <iostream>
#include <string>
#include <thread>
 
#include "I2CMutex.h"
#include "RMMRegisterAccess.h"
#include "Si570Calc.h"
#include "si5341_config.h"

struct TimingStatus {
  std::string modeOfSource;   
  std::string modeOfSync;     
  double cmnInRefclkFreqMHz;  
  bool cmnInRefclkFreqOk;     
  double si570FreqMHz;     
  bool si570FreqOk;        
  double si5341InFreqMHz;  
  bool si5341InFreqOk;     
  double tsFreqMHz;        
  bool tsFreqOk;           
  bool clkMuxLocked;       
  uint32_t currentTime;    
  double syncFreqHz;       
  uint32_t mrfStatus;  
  std::string mrfMsg;  
  uint32_t mrfMeasDelay;      
  uint32_t mrfTarDelay;       
  uint32_t mrfTopology;       
  uint32_t mrfTsErrorCount;   
  uint32_t mrfTsErrorStatus;  
};
 
enum class TimingMode { MRF = 0, LCL = 1, EXT = 2 };
enum class BringUpMode { CONCURRENT, SEQUENCTIAL };

class RMMClocks {
 public:
  RMMClocks(RMMRegisterAccess& RMMRegs);
 
  rmmStatus setupAll(TimingMode timingMode);
  rmmStatus getTimingStatus(TimingStatus* time);
  rmmStatus getCurrentTime(uint32_t* currentTime);
  rmmStatus setEventCode(uint32_t eventCode);
  bool isTimingConfigDone();
 
  RMMLog rmmLog;  
 
 private:
  static constexpr double CMN_IN_REFCLK_FREQ = 88.0525;
  static constexpr double SI570_RESET_FREQ = 156.25;
  static constexpr double SI570_TAR_FREQ = 176.105;
  static constexpr double SI5341_IN_TAR_FREQ = 158.4945;
  static constexpr double TIMESTAMP_TAR_FREQ = 88.0525;
  static constexpr double FREQ_TOLERANCE = 0.001;
  static constexpr int SI5341_ADDR = 0x77;
  static constexpr int SI5341_PAGE = 0x01;
 
  static constexpr uint32_t PPS_TARGET = 0x053F9313;       // 88052500 - 1
  static constexpr uint32_t LCL_SYNC_TARGET = 0x005FF839;  // (88052500/14)+1  For 14Hz-ish locally-generated sync
                                                           // pulses
 
  int si5341_line_count;
  int si5341_total_lines;
 
  RMMRegisterAccess& RMMRegs;
 
  rmmStatus configSi570(double new_freq = SI570_TAR_FREQ, double reset_freq = SI570_RESET_FREQ);
  rmmStatus configTiming(TimingMode mode);
  rmmStatus configSi5341();
  double getSi570Frequency();
  double getCmnInRefClkFreq();
  double getSi5341InputFreq();
  void setLocalTime();
  int si5341PageSafeWrite(std::vector<si5341EntryType> si5341_map_data, int old_page);
  void si5341ProgStatusInc();
  double getTimestampingFreq();
 
  uint32_t getTimingModeRaw();
  std::string getTimingSource();
  std::string getTimingSync();
  std::string getTimingMode();
};