Modifed RHD2000 interface to allow configuration of sync signal

- Sync signal, wired to BNC out with the update rhd2000.bit, can be set
  to a multiple of the sample clk period using the RHD2000Editor
- This commit corresponds to this pull request:
  open-ephys/rhythm#11

Author: jonnew

Builds/Linux/build/rhd2000.bit

@@ -631,12 +631,15 @@ RHD2000Editor::RHD2000Editor(GenericProcessor* parentNode,
     // add HW audio parameter selection
     audioInterface = new AudioInterface(board, this);
     addAndMakeVisible(audioInterface);
-    audioInterface->setBounds(175, 65, 65, 50);
+    audioInterface->setBounds(179, 58, 70, 50);
 
+    clockInterface = new ClockDivideInterface(board, this);
+    addAndMakeVisible(clockInterface);
+    clockInterface->setBounds(179, 82, 70, 50);
 
     adcButton = new UtilityButton("ADC 1-8", Font("Small Text", 13, Font::plain));
     adcButton->setRadius(3.0f);
-    adcButton->setBounds(175,100,65,18);
+    adcButton->setBounds(179,108,70,18);
     adcButton->addListener(this);
     adcButton->setClickingTogglesState(true);
     adcButton->setTooltip("Enable/disable ADC channels");
@@ -742,7 +745,7 @@ void RHD2000Editor::handleAsyncUpdate()
 
 		String path(CoreServices::RecordNode::getRecordingPath().getFullPathName()
                     + File::separatorString + "impedance_measurement.xml");
-        std::cout << "Saving impedance measurements in " << path << std::endl;
+        std::cout << "Saving impedance measurements in " << path << "\n";
         File file(path);
 
         if (!file.getParentDirectory().exists())
@@ -840,17 +843,17 @@ void RHD2000Editor::buttonEvent(Button* button)
     {
         board->enableAdcs(button->getToggleState());
         //        board->updateChannelNames();
-        std::cout << "ADC Button toggled" << std::endl;
+        std::cout << "ADC Button toggled" << "\n";
 		CoreServices::updateSignalChain(this);
-        std::cout << "Editor visible." << std::endl;
+        std::cout << "Editor visible." << "\n";
     }
     else if (button == dacTTLButton)
     {
         board->setTTLoutputMode(dacTTLButton->getToggleState());
     }
     else if (button == dspoffsetButton && !acquisitionIsActive)
     {
-        std::cout << "DSP offset " << button->getToggleState() << std::endl;
+        std::cout << "DSP offset " << button->getToggleState() << "\n";
         board->setDSPOffset(button->getToggleState());
     }
 	else if (button == ledButton)
@@ -1027,8 +1030,8 @@ void BandwidthInterface::labelTextChanged(Label* label)
 
             actualUpperBandwidth = board->setUpperBandwidth(requestedValue);
 
-            std::cout << "Setting Upper Bandwidth to " << requestedValue << std::endl;
-            std::cout << "Actual Upper Bandwidth:  " <<  actualUpperBandwidth  << std::endl;
+            std::cout << "Setting Upper Bandwidth to " << requestedValue << "\n";
+            std::cout << "Actual Upper Bandwidth:  " <<  actualUpperBandwidth  << "\n";
             label->setText(String(round(actualUpperBandwidth*10.f)/10.f), dontSendNotification);
 
         }
@@ -1049,8 +1052,8 @@ void BandwidthInterface::labelTextChanged(Label* label)
 
             actualLowerBandwidth = board->setLowerBandwidth(requestedValue);
 
-            std::cout << "Setting Lower Bandwidth to " << requestedValue << std::endl;
-            std::cout << "Actual Lower Bandwidth:  " <<  actualLowerBandwidth  << std::endl;
+            std::cout << "Setting Lower Bandwidth to " << requestedValue << "\n";
+            std::cout << "Actual Lower Bandwidth:  " <<  actualLowerBandwidth  << "\n";
 
             label->setText(String(round(actualLowerBandwidth*10.f)/10.f), dontSendNotification);
         }
@@ -1157,7 +1160,7 @@ void SampleRateInterface::comboBoxChanged(ComboBox* cb)
         {
             board->setSampleRate(cb->getSelectedId()-1);
 
-            std::cout << "Setting sample rate to index " << cb->getSelectedId()-1 << std::endl;
+            std::cout << "Setting sample rate to index " << cb->getSelectedId()-1 << "\n";
 
 			CoreServices::updateSignalChain(editor);
         }
@@ -1286,15 +1289,15 @@ void HeadstageOptionsInterface::buttonClicked(Button* button)
     if (!(editor->acquisitionIsActive) && board->foundInputSource())
     {
 
-        //std::cout << "Acquisition is not active" << std::endl;
+        //std::cout << "Acquisition is not active" << "\n";
         if ((button == hsButton1) && (board->getChannelsInHeadstage(hsNumber1) == 32))
         {
             if (channelsOnHs1 == 32)
                 channelsOnHs1 = 16;
             else
                 channelsOnHs1 = 32;
 
-            //std::cout << "HS1 has " << channelsOnHs1 << " channels." << std::endl;
+            //std::cout << "HS1 has " << channelsOnHs1 << " channels." << "\n";
 
             hsButton1->setLabel(String(channelsOnHs1));
             board->setNumChannels(hsNumber1, channelsOnHs1);
@@ -1390,7 +1393,7 @@ void AudioInterface::labelTextChanged(Label* label)
 
             actualNoiseSlicerLevel = board->setNoiseSlicerLevel(requestedValue);
 
-            std::cout << "Setting Noise Slicer Level to " << requestedValue << std::endl;
+            std::cout << "Setting Noise Slicer Level to " << requestedValue << "\n";
             label->setText(String((roundFloatToInt)(actualNoiseSlicerLevel)), dontSendNotification);
 
         }
@@ -1424,16 +1427,66 @@ void AudioInterface::paint(Graphics& g)
 {
 
     g.setColour(Colours::darkgrey);
-
     g.setFont(Font("Small Text",9,Font::plain));
-
     g.drawText(name, 0, 0, 200, 15, Justification::left, false);
-
     g.drawText("Level: ", 0, 10, 200, 20, Justification::left, false);
+}
+
+
+// Clock Divider options
+ClockDivideInterface::ClockDivideInterface(RHD2000Thread* board_,
+                                           RHD2000Editor* editor_) :
+   board(board_)
+ , editor(editor_)
+ 
+{
+    divideRatioSelection = new Label("Clock Divider", lastDivideRatioString); 
+    divideRatioSelection->setEditable(true,false,false);
+    divideRatioSelection->addListener(this);
+    divideRatioSelection->setBounds(30,10,30,20);
+    divideRatioSelection->setColour(Label::textColourId, Colours::darkgrey);
+    addAndMakeVisible(divideRatioSelection);
+}
+
+void ClockDivideInterface::labelTextChanged(Label* label)
+{
+    if (board->foundInputSource())
+    {
+        if (label == divideRatioSelection)
+        {
+            Value val = label->getTextValue();
+            int requestedValue = int(val.getValue()); 
+
+            if (requestedValue < 1 || requestedValue > 65534)
+            {
+				CoreServices::sendStatusMessage("Value must be between 1 and 65534.");
+                label->setText(lastDivideRatioString, dontSendNotification);
+                return;
+            }
+
+            actualDivideRatio = board->setClockDivider(requestedValue);
+            lastDivideRatioString = String(actualDivideRatio);
 
+            std::cout << "Setting clock divide ratio to " << actualDivideRatio << "\n";
+            label->setText(lastDivideRatioString, dontSendNotification);
+        }
+    }
 }
 
+void ClockDivideInterface::setClockDivideRatio(int value)
+{
+    actualDivideRatio = board->setClockDivider(value);
+    divideRatioSelection->setText(String(actualDivideRatio), dontSendNotification);
+}
 
+void ClockDivideInterface::paint(Graphics& g)
+{
+
+    g.setColour(Colours::darkgrey);
+    g.setFont(Font("Small Text",9,Font::plain));
+    g.drawText(name, 0, 0, 200, 15, Justification::left, false);
+    g.drawText("Level: ", 0, 10, 200, 20, Justification::left, false);
+}
 
 // DSP Options --------------------------------------------------------------------
 
@@ -1472,8 +1525,8 @@ void DSPInterface::labelTextChanged(Label* label)
 
             actualDspCutoffFreq = board->setDspCutoffFreq(requestedValue);
 
-            std::cout << "Setting DSP Cutoff Freq to " << requestedValue << std::endl;
-            std::cout << "Actual DSP Cutoff Freq:  " <<  actualDspCutoffFreq  << std::endl;
+            std::cout << "Setting DSP Cutoff Freq to " << requestedValue << "\n";
+            std::cout << "Actual DSP Cutoff Freq:  " <<  actualDspCutoffFreq  << "\n";
             label->setText(String(round(actualDspCutoffFreq*10.f)/10.f), dontSendNotification);
 
         }

Builds/MacOSX/build/Debug/rhd2000.bit

@@ -35,6 +35,7 @@ class SampleRateInterface;
 class BandwidthInterface;
 class DSPInterface;
 class AudioInterface;
+class ClockDivideInterface;
 class RHD2000Thread;
 
 class UtilityButton;
@@ -199,6 +200,7 @@ class RHD2000Editor : public VisualizerEditor, public ComboBox::Listener, public
     ScopedPointer<DSPInterface> dspInterface;
 
     ScopedPointer<AudioInterface> audioInterface;
+    ScopedPointer<ClockDivideInterface> clockInterface;
 
     ScopedPointer<UtilityButton> rescanButton,dacTTLButton;
     ScopedPointer<UtilityButton> adcButton;
@@ -371,5 +373,28 @@ class AudioInterface : public Component,
 
 };
 
+class ClockDivideInterface : public Component,
+    public Label::Listener
+{
+public:
+    ClockDivideInterface(RHD2000Thread*, RHD2000Editor*);
+
+    void paint(Graphics& g);
+    void labelTextChanged(Label* te);
+
+    void setClockDivideRatio(int value);
+    int getClockDivideRatio() const { return actualDivideRatio; };
 
+private:
+
+    String name {"Clock Divider"};
+    String lastDivideRatioString {"1"};
+
+    RHD2000Thread * board;
+    RHD2000Editor * editor;
+
+    ScopedPointer<Label> divideRatioSelection;
+    int actualDivideRatio {1};
+
+};
 #endif  // __RHD2000EDITOR_H_2AD3C591__

Resources/Bitfiles/rhd2000.bit

@@ -1821,6 +1821,32 @@ void RHD2000Thread::enableBoardLeds(bool enable)
 		evalBoard->enableBoardLeds(enable);
 }
 
+int RHD2000Thread::setClockDivider(int divide_ratio)
+{
+    // TODO: only allow if not running?
+	//if (isAcquisitionActive())
+    //
+    uint16_t N;
+    
+    // Divide ratio should be 1 or an even number
+    if (divide_ratio != 1 && divide_ratio % 2) 
+        divide_ratio--;
+
+    // Format the divide ratio from its true value to the 
+    // format required by the firmware
+    // Ratio    N
+    // 1        0
+    // >=2      Ratio/2
+    if (divide_ratio == 1)
+        N = 0;
+    else
+        N = static_cast<uint16_t>(divide_ratio/2);
+
+    evalBoard->setClockDivider(N);
+
+    return divide_ratio;
+}
+
 void RHD2000Thread::runImpedanceTest(ImpedanceData* data)
 {
 	impedanceThread->stopThreadSafely();
@@ -2449,4 +2475,4 @@ void RHDImpedanceMeasure::restoreFPGA()
 	{
 		board->evalBoard->enableExternalFastSettle(true);
 	}
-}
+}

Source/Processors/DataThreads/RHD2000Editor.cpp

@@ -130,6 +130,7 @@ class RHD2000Thread : public DataThread, public Timer
 
 	void runImpedanceTest(ImpedanceData* data);
 	void enableBoardLeds(bool enable);
+	int setClockDivider(int divide_ratio);
 
 private:
 

Source/Processors/DataThreads/RHD2000Editor.h

@@ -1667,6 +1667,17 @@ void Rhd2000EvalBoard::enableBoardLeds(bool enable)
 	dev->ActivateTriggerIn(TrigInOpenEphys, 0);
 }
 
+// Ratio    divide_factor
+// 1        0
+// >=2      Ratio/2
+void Rhd2000EvalBoard::setClockDivider(uint16_t divide_factor)
+{
+
+	dev->SetWireInValue(WireInMultiUse, divide_factor);
+	dev->UpdateWireIns();
+	dev->ActivateTriggerIn(TrigInOpenEphys, 1);
+}
+
 bool Rhd2000EvalBoard::isUSB3()
 {
 	return usb3;
@@ -1676,4 +1687,4 @@ void Rhd2000EvalBoard::printFIFOmetrics()
 {
 	dev->UpdateWireOuts();
 	std::cout << "In FIFO: " << dev->GetWireOutValue(0x28) << " DDR: " << dev->GetWireOutValue(0x2a) << " Out FIFO: " << dev->GetWireOutValue(0x29) << std::endl;
-}
+}

Source/Processors/DataThreads/RHD2000Thread.cpp

@@ -166,6 +166,7 @@ class Rhd2000EvalBoard
 	void resetFpga();
 	bool isStreamEnabled(int streamIndex);
 	void enableBoardLeds(bool enable);
+	void setClockDivider(uint16_t divide_factor);
 	bool isUSB3();
 	void printFIFOmetrics();
 	bool readRawDataBlock(unsigned char** bufferPtr, int nSamples = -1);