00001 #ifndef _ots_FSSRFirmware_h_
00002 #define _ots_FSSRFirmware_h_
00003
00004 #include <string>
00005
00006
00007 #include "otsdaq-components/DAQHardware/FirmwareSequence.h"
00008 #include "otsdaq-components/DetectorConfiguration/ROCStream.h"
00009
00010
00011
00012
00013 namespace ots
00014 {
00015
00016
00017
00018
00019
00020
00021
00022
00023
00024
00025
00026
00027
00028
00029
00030
00031
00032
00033
00034
00035
00036
00037
00038
00039
00040
00041
00042
00043
00044
00045
00046
00047 class FrontEndFirmwareBase;
00048
00049 class FSSRFirmwareBase
00050 {
00051
00052 public:
00053 FSSRFirmwareBase (const std::string& communicationFirmwareType, unsigned int communicationFirmwareVersion = -1, unsigned int version = -1);
00054 virtual ~FSSRFirmwareBase (void);
00055 void init (void);
00056
00057 std::string universalRead (char* address);
00058 std::string universalWrite (char* address, char* data);
00059
00060
00061 uint32_t createRegisterFromValue (std::string& readBuffer, std::string& receivedValue);
00062
00063
00064 std::string configureClocks (std::string source, double frequency);
00065 std::string resetDetector (int channel=-1);
00066 std::string enableTrigger (void);
00067
00068
00069
00070 void resetDCM (std::string& buffer);
00071 void alignReadOut (std::string& buffer, unsigned int sensor, unsigned int chip);
00072 void makeDACSequence (FirmwareSequence<uint64_t>& sequence, unsigned int channel, const ROCStream& rocStream);
00073 void makeDACSequence (FirmwareSequence<uint32_t>& sequence, unsigned int channel, const ROCStream& rocStream);
00074 void makeMaskSequence (FirmwareSequence<uint64_t>& sequence, unsigned int channel, const ROCStream& rocStream);
00075 void makeMaskSequence (FirmwareSequence<uint32_t>& sequence, unsigned int channel, const ROCStream& rocStream);
00076
00077 void makeDACBuffer (std::string& buffer, unsigned int channel, const ROCStream& rocStream);
00078 void makeDACBuffer (std::vector<std::string>& buffer, unsigned int channel, const ROCStream& rocStream);
00079 void makeMaskBuffer (std::string& buffer, unsigned int channel, const ROCStream& rocStream);
00080 void setFrequencyFromClockState (std::string& buffer, double frequency);
00081 bool isClockStateExternal (void);
00082
00083 std::string readFromAddress (uint64_t address);
00084
00085
00086 std::string resetBCO (void);
00087 std::string armBCOReset (void);
00088 std::string startStream (bool channel0, bool channel1, bool channel2, bool channel3, bool channel4, bool channel5);
00089 std::string stopStream (void);
00090
00091
00092 void makeMaskSequence (FirmwareSequence<uint64_t>& sequence, unsigned int channel, const ROCStream& rocStream, const std::string& registerName);
00093 void makeMaskSequence (FirmwareSequence<uint32_t>& sequence, unsigned int channel, const ROCStream& rocStream, const std::string& registerName);
00094 void makeMaskBuffer (std::string& buffer, unsigned int channel, const ROCStream& rocStream, const std::string& registerName);
00095
00096 void setCSRRegister (uint32_t total);
00097
00098
00099
00100
00101
00102
00103
00104
00106
00107
00108
00109
00110
00111
00112
00113
00114
00116
00117
00118
00119
00120
00121
00122
00123
00124
00125
00126 uint32_t stripCSRRegisterValue_;
00127 void setPacketSizeStripCSR (uint32_t size);
00128 void enableChannelsStripCSR (bool channel0, bool channel1, bool channel2, bool channel3, bool channel4, bool channel5);
00129 void setExternalBCOClockSourceStripCSR(std::string clockSource);
00130
00131 void armBCOResetCSR (void);
00132 void flushBuffersStripCSR (void);
00133 void resetTriggerCounterStripCSR (std::string& buffer);
00134 void resetBCOCounterStripCSR (void);
00135 void enableTriggerStripCSR (bool enable);
00136 void sendTriggerDataStripCSR (bool send);
00137 void sendTriggerNumberStripCSR (bool send);
00138 void sendBCOStripCSR (bool send);
00139 void enableStreamStripCSR (bool enable);
00140 void resetDCMStripCSR (bool clear);
00141 uint32_t waitDCMResetStripCSR (void);
00142 std::string readCSRRegister (void);
00143
00144 std::string readSCCSRRegister (void);
00145
00146 uint32_t stripResetRegisterValue_;
00147
00148 void resetStripResetRegisterValue(void)
00149 {
00150 stripResetRegisterValue_ = 0;
00151 }
00152 void resetDAC (void);
00153 void resetLink (bool channel0, bool channel1, bool channel2, bool channel3, bool channel4, bool channel5);
00154 void clearErrors (bool channel0, bool channel1, bool channel2, bool channel3, bool channel4, bool channel5);
00155 void clearFIFO (bool channel0, bool channel1, bool channel2, bool channel3, bool channel4, bool channel5);
00156 void resetChip (bool channel0, bool channel1, bool channel2, bool channel3, bool channel4, bool channel5);
00157
00158 uint32_t stripBCODCMRegisterValue_;
00159 void setFrequencyRatio (std::string& buffer, int numerator, int denominator);
00160
00161 void configureStripTriggerUnbiased (std::string& buffer);
00162 void configureTriggerInputs (std::string& buffer);
00163
00164
00165 uint32_t stripTriggerCSRRegisterValue_;
00166
00167
00168 void BCOOffset (uint32_t offset);
00169 void selectSpyFIFO (uint32_t input);
00170 void halt (bool halt);
00171
00172
00173 std::string resetSlaveBCO(void);
00174
00175 static const std::string PURDUE_FIRMWARE_NAME;
00176 static const std::string OTS_FIRMWARE_NAME;
00177
00178 FrontEndFirmwareBase* communicationFirmwareInstance_;
00179
00180 protected:
00181 unsigned int version_;
00182 const std::string communicationFirmwareType_;
00183 };
00184
00185 }
00186
00187 #endif