Skip to content

Commit 3c08e4a

Browse files
bparks13bparks13
authored
Merge pull request #14 from open-ephys-plugins/issue-2
Check Port Status during acquisition
2 parents 4ac8fe0 + ab6a682 commit 3c08e4a

16 files changed

+470
-271
lines changed

‎Source/Devices/Bno055.cpp

+2-4
Original file line numberDiff line numberDiff line change
@@ -93,11 +93,9 @@ Bno055::~Bno055()
9393

9494
int Bno055::configureDevice()
9595
{
96-
int result = oni_write_reg(ctx, deviceIdx, (uint32_t)Bno055Registers::ENABLE, isEnabled() ? (oni_reg_val_t)1 : (oni_reg_val_t)0);
96+
ONI_OK_RETURN_INT(oni_write_reg(ctx, deviceIdx, (uint32_t)Bno055Registers::ENABLE, isEnabled() ? (oni_reg_val_t)1 : (oni_reg_val_t)0));
9797

98-
if (result != ONI_ESUCCESS) LOGE(oni_error_str(result));
99-
100-
return result;
98+
return 0;
10199
}
102100

103101
int Bno055::updateSettings()

‎Source/Devices/DeviceList.h

+1
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,4 @@
33
#include "HeadStageEEPROM.h"
44
#include "Neuropixels_1.h"
55
#include "Neuropixels2e.h"
6+
#include "PortController.h"

‎Source/Devices/Neuropixels_1.cpp

+4-1
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,10 @@ BackgroundUpdaterWithProgressWindow::~BackgroundUpdaterWithProgressWindow()
3636

3737
int BackgroundUpdaterWithProgressWindow::updateSettings()
3838
{
39-
runThread();
39+
if (device->isEnabled())
40+
runThread();
41+
else
42+
return 0;
4043

4144
return result;
4245
}

‎Source/Devices/PortController.cpp

+171
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,171 @@
1+
/*
2+
------------------------------------------------------------------
3+
4+
This file is part of the Open Ephys GUI
5+
Copyright (C) 2023 Allen Institute for Brain Science and Open Ephys
6+
7+
------------------------------------------------------------------
8+
9+
This program is free software: you can redistribute it and/or modify
10+
it under the terms of the GNU General Public License as published by
11+
the Free Software Foundation, either version 3 of the License, or
12+
(at your option) any later version.
13+
14+
This program is distributed in the hope that it will be useful,
15+
but WITHOUT ANY WARRANTY; without even the implied warranty of
16+
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17+
GNU General Public License for more details.
18+
19+
You should have received a copy of the GNU General Public License
20+
along with this program. If not, see <http://www.gnu.org/licenses/>.
21+
22+
*/
23+
24+
#include "PortController.h"
25+
26+
PortController::PortController(PortName port_, oni_ctx ctx_) :
27+
OnixDevice(getPortNameString(port_), OnixDeviceType::PORT_CONTROL, (oni_dev_idx_t)port_, ctx_),
28+
port(port_)
29+
{
30+
}
31+
32+
PortController::~PortController()
33+
{
34+
}
35+
36+
int PortController::configureDevice()
37+
{
38+
ONI_OK_RETURN_INT(oni_write_reg(ctx, deviceIdx, (uint32_t)PortControllerRegister::ENABLE, (uint32_t)1))
39+
40+
return 0;
41+
}
42+
43+
void PortController::startAcquisition()
44+
{
45+
errorFlag = false;
46+
}
47+
48+
void PortController::stopAcquisition()
49+
{
50+
while (!frameArray.isEmpty())
51+
{
52+
const GenericScopedLock<CriticalSection> frameLock(frameArray.getLock());
53+
oni_destroy_frame(frameArray.removeAndReturn(0));
54+
}
55+
}
56+
57+
void PortController::addFrame(oni_frame_t* frame)
58+
{
59+
const GenericScopedLock<CriticalSection> frameLock(frameArray.getLock());
60+
frameArray.add(frame);
61+
}
62+
63+
void PortController::processFrames()
64+
{
65+
while (!frameArray.isEmpty())
66+
{
67+
const GenericScopedLock<CriticalSection> frameLock(frameArray.getLock());
68+
oni_frame_t* frame = frameArray.removeAndReturn(0);
69+
70+
int8_t* dataPtr = (int8_t*)frame->data;
71+
72+
int dataOffset = 8;
73+
74+
uint32_t code = (uint32_t) *(dataPtr + dataOffset);
75+
uint32_t data = (uint32_t) *(dataPtr + dataOffset + 1);
76+
77+
errorFlag = errorFlag || ((uint32_t)data & LINKSTATE_SL) == 0;
78+
79+
oni_destroy_frame(frame);
80+
81+
LOGE("Port status changed for " + getName() + ".");
82+
}
83+
}
84+
85+
void PortController::updateDiscoveryParameters(DiscoveryParameters parameters)
86+
{
87+
discoveryParameters = parameters;
88+
}
89+
90+
DiscoveryParameters PortController::getHeadstageDiscoveryParameters(String headstage)
91+
{
92+
if (headstage == "Neuropixels 1.0f")
93+
{
94+
return DiscoveryParameters(5.0f, 7.0f, 1.0f, 0.2f);
95+
}
96+
97+
return DiscoveryParameters();
98+
}
99+
100+
bool PortController::configureVoltage(float voltage)
101+
{
102+
if (ctx == NULL) return false;
103+
104+
if (voltage == defaultVoltage)
105+
{
106+
if (discoveryParameters == DiscoveryParameters()) return false;
107+
108+
for (voltage = discoveryParameters.minVoltage; voltage <= discoveryParameters.maxVoltage; voltage += discoveryParameters.voltageIncrement)
109+
{
110+
setVoltage(voltage);
111+
112+
if (checkLinkState())
113+
{
114+
setVoltage(voltage + discoveryParameters.voltageOffset);
115+
return checkLinkState();
116+
}
117+
}
118+
}
119+
else
120+
{
121+
setVoltage(voltage);
122+
123+
return checkLinkState();
124+
}
125+
126+
return false;
127+
}
128+
129+
void PortController::setVoltageOverride(float voltage, bool waitToSettle)
130+
{
131+
if (ctx == NULL) return;
132+
133+
ONI_OK(oni_write_reg(ctx, (oni_dev_idx_t)port, (oni_reg_addr_t)PortControllerRegister::PORTVOLTAGE, (oni_reg_val_t)(voltage * 10)));
134+
if (waitToSettle) sleep_for(std::chrono::milliseconds(500));
135+
}
136+
137+
void PortController::setVoltage(float voltage)
138+
{
139+
if (ctx == NULL) return;
140+
141+
ONI_OK(oni_write_reg(ctx, (oni_dev_idx_t)port, (oni_reg_addr_t)PortControllerRegister::PORTVOLTAGE, 0));
142+
sleep_for(std::chrono::milliseconds(300));
143+
144+
ONI_OK(oni_write_reg(ctx, (oni_dev_idx_t)port, (oni_reg_addr_t)PortControllerRegister::PORTVOLTAGE, (oni_reg_val_t)(voltage * 10)));
145+
sleep_for(std::chrono::milliseconds(500));
146+
}
147+
148+
bool PortController::checkLinkState() const
149+
{
150+
if (ctx == NULL) return false;
151+
152+
oni_reg_val_t linkState;
153+
int result = oni_read_reg(ctx, (oni_dev_idx_t)port, (oni_reg_addr_t)PortControllerRegister::LINKSTATE, &linkState);
154+
155+
if (result != 0) { LOGE(oni_error_str(result)); return false; }
156+
else if ((linkState & LINKSTATE_SL) == 0) { LOGE("Unable to acquire communication lock."); return false; }
157+
else return true;
158+
}
159+
160+
String PortController::getPortNameString(PortName portName)
161+
{
162+
switch (portName)
163+
{
164+
case PortName::PortA:
165+
return "Port A";
166+
case PortName::PortB:
167+
return "Port B";
168+
default:
169+
break;
170+
}
171+
}

‎Source/Devices/PortController.h

+137
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,137 @@
1+
/*
2+
------------------------------------------------------------------
3+
4+
This file is part of the Open Ephys GUI
5+
Copyright (C) 2023 Allen Institute for Brain Science and Open Ephys
6+
7+
------------------------------------------------------------------
8+
9+
This program is free software: you can redistribute it and/or modify
10+
it under the terms of the GNU General Public License as published by
11+
the Free Software Foundation, either version 3 of the License, or
12+
(at your option) any later version.
13+
14+
This program is distributed in the hope that it will be useful,
15+
but WITHOUT ANY WARRANTY; without even the implied warranty of
16+
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17+
GNU General Public License for more details.
18+
19+
You should have received a copy of the GNU General Public License
20+
along with this program. If not, see <http://www.gnu.org/licenses/>.
21+
22+
*/
23+
24+
#ifndef __PORTCONTROLLER_H__
25+
#define __PORTCONTROLLER_H__
26+
27+
#include <thread>
28+
#include <chrono>
29+
30+
#include "oni.h"
31+
#include "../OnixDevice.h"
32+
33+
using namespace std::this_thread;
34+
35+
enum class PortControllerRegister : uint32_t
36+
{
37+
ENABLE = 0,
38+
GPOSTATE = 1,
39+
DESPWR = 2,
40+
PORTVOLTAGE = 3,
41+
SAVEVOLTAGE = 4,
42+
LINKSTATE = 5
43+
};
44+
45+
enum class PortStatusCode : uint32_t
46+
{
47+
SerdesLock = 0x0001,
48+
SerdesParityPass = 0x0002,
49+
CrcError = 0x0100,
50+
TooManyDevices = 0x0200,
51+
InitializationError = 0x0400,
52+
BadPacketFormat = 0x0800,
53+
InitializationCrcError = 0x1000,
54+
};
55+
56+
class DiscoveryParameters
57+
{
58+
public:
59+
float minVoltage = 0.0f;
60+
float maxVoltage = 0.0f;
61+
float voltageOffset = 0.0f;
62+
float voltageIncrement = 0.0f;
63+
64+
DiscoveryParameters() {};
65+
66+
DiscoveryParameters(float minVoltage_, float maxVoltage_, float voltageOffset_, float voltageIncrement_)
67+
{
68+
minVoltage = minVoltage_;
69+
maxVoltage = maxVoltage_;
70+
voltageOffset = voltageOffset_;
71+
voltageIncrement = voltageIncrement_;
72+
}
73+
74+
~DiscoveryParameters() {};
75+
76+
bool operator==(const DiscoveryParameters& rhs) const
77+
{
78+
return rhs.minVoltage == minVoltage && rhs.maxVoltage == maxVoltage && rhs.voltageOffset == voltageOffset && rhs.voltageIncrement == voltageIncrement;
79+
}
80+
};
81+
82+
class PortController : public OnixDevice
83+
{
84+
public:
85+
PortController(PortName port_, const oni_ctx ctx_);
86+
87+
~PortController();
88+
89+
int configureDevice() override;
90+
91+
int updateSettings() override { return 0; }
92+
93+
void startAcquisition() override;
94+
95+
void stopAcquisition() override;
96+
97+
void addFrame(oni_frame_t*) override;
98+
99+
void processFrames() override;
100+
101+
void addSourceBuffers(OwnedArray<DataBuffer>& sourceBuffers) override {};
102+
103+
void updateDiscoveryParameters(DiscoveryParameters parameters);
104+
105+
bool configureVoltage(float voltage = defaultVoltage);
106+
107+
/** Sets the voltage to the given value, after setting the voltage to zero */
108+
void setVoltage(float voltage);
109+
110+
/** Overrides the voltage setting and directly sets it to the given voltage */
111+
void setVoltageOverride(float voltage, bool waitToSettle = true);
112+
113+
bool checkLinkState() const;
114+
115+
String getPortNameString(PortName portName);
116+
117+
static DiscoveryParameters getHeadstageDiscoveryParameters(String headstage);
118+
119+
/** Check if the port status changed and there is an error reported */
120+
bool getErrorFlag() { return errorFlag; }
121+
122+
private:
123+
Array<oni_frame_t*, CriticalSection, 10> frameArray;
124+
125+
const PortName port;
126+
127+
static constexpr float defaultVoltage = -1.0f;
128+
129+
const uint32_t LINKSTATE_PP = 0x2; // parity check pass bit
130+
const uint32_t LINKSTATE_SL = 0x1; // SERDES lock bit
131+
132+
DiscoveryParameters discoveryParameters;
133+
134+
std::atomic<bool> errorFlag = false;
135+
};
136+
137+
#endif // !__PORTCONTROLLER_H__

‎Source/FrameReader.cpp

+2-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323

2424
#include "FrameReader.h"
2525

26-
FrameReader::FrameReader(OwnedArray<OnixDevice>& sources_, oni_ctx ctx_)
26+
FrameReader::FrameReader(Array<OnixDevice*> sources_, oni_ctx ctx_)
2727
: Thread("FrameReader"),
2828
sources(sources_),
2929
ctx(ctx_)
@@ -62,6 +62,7 @@ void FrameReader::run()
6262
{
6363
source->addFrame(frame);
6464
destroyFrame = false;
65+
break;
6566
}
6667
}
6768

‎Source/FrameReader.h

+2-2
Original file line numberDiff line numberDiff line change
@@ -32,15 +32,15 @@
3232
class FrameReader : public Thread
3333
{
3434
public:
35-
FrameReader(OwnedArray<OnixDevice>& sources_, oni_ctx ctx_);
35+
FrameReader(Array<OnixDevice*> sources_, oni_ctx ctx_);
3636

3737
~FrameReader();
3838

3939
void run() override;
4040

4141
private:
4242

43-
OwnedArray<OnixDevice>& sources;
43+
Array<OnixDevice*> sources;
4444
oni_ctx ctx;
4545
};
4646

‎Source/OnixDevice.h

+3-2
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@
3939

4040
#define ONI_OK(exp) {int res = exp; if (res != ONI_ESUCCESS){LOGD(oni_error_str(res));}}
4141
#define ONI_OK_RETURN_BOOL(exp) {int res = exp; if (res != ONI_ESUCCESS){LOGD(oni_error_str(res));return false;}}
42-
#define ONI_OK_RETURN_INT(exp, val) {int res = exp; if (res != ONI_ESUCCESS){LOGD(oni_error_str(res));return val;}}
42+
#define ONI_OK_RETURN_INT(exp) {int res = exp; if (res != ONI_ESUCCESS){LOGD(oni_error_str(res));return res;}}
4343

4444
using namespace std::chrono;
4545

@@ -54,7 +54,8 @@ enum class OnixDeviceType {
5454
BNO,
5555
NEUROPIXELS_1,
5656
NEUROPIXELS_2,
57-
ADC
57+
ADC,
58+
PORT_CONTROL
5859
};
5960

6061
struct StreamInfo {

0 commit comments

Comments
 (0)