detectors/slsDetectorPackage
25
0
Fork 0
mirror of https://github.com/slsdetectorgroup/slsDetectorPackage.git synced 2025-04-19 18:40:01 +02:00
Code Issues Actions Packages Releases Activity

Dev/reg bit change no validate (#970)

Browse Source 
- do not validate write reg, setbit and clearbit by default anymore
- --validate will force validation on the bitmask or entire reg
- remove return value for write reg (across server to client, but thankfully not in the Detector class)
- extend validation into writereg, setbit and clearbit for Eiger (always special)
-  need to check python (TODO)
- missed the rx_zmqip implementations in detector.h and python bindings
This commit is contained in:
maliakal_d 2024-09-30 16:54:12 +02:00 committed by GitHub
parent a44ba4dc35
commit 2dc0963c56
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
33 changed files with 499 additions and 171 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
python/slsdet/registers.py
View File

@ -8,7 +8,7 @@ class Register:
return self._detector.readRegister(key)
def __setitem__(self, key, value):
self._detector.writeRegister(key, value)
self._detector.writeRegister(key, value, False)
class Adc_register:
def __init__(self, detector):

18
python/src/detector.cpp
View File

@ -1940,17 +1940,19 @@ void init_det(py::module &m) {
py::arg(), py::arg() = Positions{});
CppDetectorApi.def(
"writeRegister",
(void (Detector::*)(uint32_t, uint32_t, sls::Positions)) &
(void (Detector::*)(uint32_t, uint32_t, bool, sls::Positions)) &
Detector::writeRegister,
py::arg(), py::arg(), py::arg() = Positions{});
CppDetectorApi.def("setBit",
(void (Detector::*)(uint32_t, int, sls::Positions)) &
py::arg(), py::arg(), py::arg() = false, py::arg() = Positions{});
CppDetectorApi.def(
"setBit",
(void (Detector::*)(uint32_t, int, bool, sls::Positions)) &
Detector::setBit,
py::arg(), py::arg(), py::arg() = Positions{});
CppDetectorApi.def("clearBit",
(void (Detector::*)(uint32_t, int, sls::Positions)) &
py::arg(), py::arg(), py::arg() = false, py::arg() = Positions{});
CppDetectorApi.def(
"clearBit",
(void (Detector::*)(uint32_t, int, bool, sls::Positions)) &
Detector::clearBit,
py::arg(), py::arg(), py::arg() = Positions{});
py::arg(), py::arg(), py::arg() = false, py::arg() = Positions{});
CppDetectorApi.def(
"getBit",
(Result<int>(Detector::*)(uint32_t, int, sls::Positions)) &

BIN
slsDetectorServers/ctbDetectorServer/bin/ctbDetectorServer_developer
View File

Binary file not shown.

22
slsDetectorServers/eigerDetectorServer/FebControl.c
View File

@ -1251,7 +1251,8 @@ int Feb_Control_Disable16bitConversion(int disable) {
regval &= ~bitmask;
}
if (!Feb_Control_WriteRegister_BitMask(DAQ_REG_HRDWRE, regval, bitmask)) {
if (!Feb_Control_WriteRegister_BitMask(DAQ_REG_HRDWRE, regval, bitmask,
1)) {
LOG(logERROR, ("Could not %s 16 bit expansion (bit mode)\n",
(disable ? "disable" : "enable")));
return 0;
@ -1637,7 +1638,7 @@ int Feb_Control_SetChipSignalsToTrimQuad(int enable) {
regval &= ~(DAQ_REG_HRDWRE_PROGRAM_MSK | DAQ_REG_HRDWRE_M8_MSK);
}
if (!Feb_Control_WriteRegister(righOffset, regval)) {
if (!Feb_Control_WriteRegister(righOffset, regval, 1)) {
LOG(logERROR, ("Could not set chip signals to trim quad\n"));
return 0;
}
@ -1666,8 +1667,10 @@ int Feb_Control_GetReadNRows() {
return regVal;
}
int Feb_Control_WriteRegister(uint32_t offset, uint32_t data) {
return Feb_Control_WriteRegister_BitMask(offset, data, BIT32_MSK);
int Feb_Control_WriteRegister(uint32_t offset, uint32_t data, int validate) {
if (!Feb_Control_WriteRegister_BitMask(offset, data, BIT32_MSK, validate))
return 0;
return 1;
}
int Feb_Control_ReadRegister(uint32_t offset, uint32_t *retval) {
@ -1675,7 +1678,7 @@ int Feb_Control_ReadRegister(uint32_t offset, uint32_t *retval) {
}
int Feb_Control_WriteRegister_BitMask(uint32_t offset, uint32_t data,
uint32_t bitmask) {
uint32_t bitmask, int validate) {
uint32_t actualOffset = offset;
char side[2][10] = {"right", "left"};
unsigned int addr[2] = {Feb_Control_rightAddress, Feb_Control_leftAddress};
@ -1720,7 +1723,8 @@ int Feb_Control_WriteRegister_BitMask(uint32_t offset, uint32_t data,
writeVal, side[iloop], actualOffset));
return 0;
}
writeVal &= bitmask;
if (validate) {
uint32_t readVal = 0;
if (!Feb_Interface_ReadRegister(addr[iloop], actualOffset,
@ -1728,16 +1732,18 @@ int Feb_Control_WriteRegister_BitMask(uint32_t offset, uint32_t data,
return 0;
}
readVal &= bitmask;
writeVal &= bitmask;
if (writeVal != readVal) {
LOG(logERROR,
("Could not write %s addr 0x%x register. Wrote "
"0x%x, read 0x%x (mask:0x%x)\n",
side[iloop], actualOffset, writeVal, readVal, bitmask));
side[iloop], actualOffset, writeVal, readVal,
bitmask));
return 0;
}
}
}
}
return 1;
}

4
slsDetectorServers/eigerDetectorServer/FebControl.h
View File

@ -93,10 +93,10 @@ int Feb_Control_SetQuad(int val);
int Feb_Control_SetChipSignalsToTrimQuad(int enable);
int Feb_Control_SetReadNRows(int value);
int Feb_Control_GetReadNRows();
int Feb_Control_WriteRegister(uint32_t offset, uint32_t data);
int Feb_Control_WriteRegister(uint32_t offset, uint32_t data, int validate);
int Feb_Control_ReadRegister(uint32_t offset, uint32_t *retval);
int Feb_Control_WriteRegister_BitMask(uint32_t offset, uint32_t data,
uint32_t bitmask);
uint32_t bitmask, int validate);
int Feb_Control_ReadRegister_BitMask(uint32_t offset, uint32_t *retval,
uint32_t bitmask);
// pulsing

BIN
slsDetectorServers/eigerDetectorServer/bin/eigerDetectorServer_developer
View File

Binary file not shown.

12
slsDetectorServers/eigerDetectorServer/slsDetectorFunctionList.c
View File

@ -883,12 +883,12 @@ int setDefaultDac(enum DACINDEX index, enum detectorSettings sett, int value) {
}
/* advanced read/write reg */
int writeRegister(uint32_t offset, uint32_t data) {
int writeRegister(uint32_t offset, uint32_t data, int validate) {
#ifdef VIRTUAL
return OK;
#else
sharedMemory_lockLocalLink();
if (!Feb_Control_WriteRegister(offset, data)) {
if (!Feb_Control_WriteRegister(offset, data, validate)) {
sharedMemory_unlockLocalLink();
return FAIL;
}
@ -911,7 +911,7 @@ int readRegister(uint32_t offset, uint32_t *retval) {
#endif
}
int setBit(const uint32_t addr, const int nBit) {
int setBit(const uint32_t addr, const int nBit, int validate) {
#ifndef VIRTUAL
uint32_t regval = 0;
if (readRegister(addr, &regval) == FAIL) {
@ -921,7 +921,7 @@ int setBit(const uint32_t addr, const int nBit) {
uint32_t val = regval | bitmask;
sharedMemory_lockLocalLink();
if (!Feb_Control_WriteRegister_BitMask(addr, val, bitmask)) {
if (!Feb_Control_WriteRegister_BitMask(addr, val, bitmask, validate)) {
sharedMemory_unlockLocalLink();
return FAIL;
}
@ -930,7 +930,7 @@ int setBit(const uint32_t addr, const int nBit) {
return OK;
}
int clearBit(const uint32_t addr, const int nBit) {
int clearBit(const uint32_t addr, const int nBit, int validate) {
#ifndef VIRTUAL
uint32_t regval = 0;
if (readRegister(addr, &regval) == FAIL) {
@ -940,7 +940,7 @@ int clearBit(const uint32_t addr, const int nBit) {
uint32_t val = regval & ~bitmask;
sharedMemory_lockLocalLink();
if (!Feb_Control_WriteRegister_BitMask(addr, val, bitmask)) {
if (!Feb_Control_WriteRegister_BitMask(addr, val, bitmask, validate)) {
sharedMemory_unlockLocalLink();
return FAIL;
}

BIN
slsDetectorServers/gotthard2DetectorServer/bin/gotthard2DetectorServer_developer
View File

Binary file not shown.

BIN
slsDetectorServers/gotthardDetectorServer/bin/gotthardDetectorServer_developer
View File

Binary file not shown.

6
slsDetectorServers/gotthardDetectorServer/slsDetectorFunctionList.c
View File

@ -527,12 +527,12 @@ int setDefaultDac(enum DACINDEX index, enum detectorSettings sett, int value) {
return OK;
}
uint32_t writeRegister16And32(uint32_t offset, uint32_t data) {
void writeRegister16And32(uint32_t offset, uint32_t data) {
if (((offset << MEM_MAP_SHIFT) == CONTROL_REG) ||
((offset << MEM_MAP_SHIFT) == FIFO_DATA_REG)) {
return writeRegister16(offset, data);
writeRegister16(offset, data);
} else
return writeRegister(offset, data);
writeRegister(offset, data);
}
uint32_t readRegister16And32(uint32_t offset) {

BIN
slsDetectorServers/jungfrauDetectorServer/bin/jungfrauDetectorServer_developer
View File

Binary file not shown.

BIN
slsDetectorServers/moenchDetectorServer/bin/moenchDetectorServer_developer
View File

Binary file not shown.

BIN
slsDetectorServers/mythen3DetectorServer/bin/mythen3DetectorServer_developer
View File

Binary file not shown.

4
slsDetectorServers/slsDetectorServer/include/blackfin.h
View File

@ -81,7 +81,7 @@ u_int32_t readRegister(u_int32_t offset);
* @param offset address offset
* @param data 32 bit data
*/
u_int32_t writeRegister(u_int32_t offset, u_int32_t data);
void writeRegister(u_int32_t offset, u_int32_t data);
/**
* Read from a 16 bit register (literal register value provided by client)
@ -95,7 +95,7 @@ u_int32_t readRegister16(u_int32_t offset);
* @param offset address offset
* @param data 16 bit data
*/
u_int32_t writeRegister16(u_int32_t offset, u_int32_t data);
void writeRegister16(u_int32_t offset, u_int32_t data);
/**
* Get base address for memory copy

2
slsDetectorServers/slsDetectorServer/include/nios.h
View File

@ -78,7 +78,7 @@ u_int32_t readRegister(u_int32_t offset);
* @param offset address offset
* @param data 32 bit data
*/
u_int32_t writeRegister(u_int32_t offset, u_int32_t data);
void writeRegister(u_int32_t offset, u_int32_t data);
/**
* Map FPGA

9
slsDetectorServers/slsDetectorServer/include/slsDetectorFunctionList.h
View File

@ -172,14 +172,13 @@ void resetToHardwareSettings();
// advanced read/write reg
#ifdef EIGERD
int writeRegister(uint32_t offset, uint32_t data);
int writeRegister(uint32_t offset, uint32_t data, int validate);
int readRegister(uint32_t offset, uint32_t *retval);
int setBit(const uint32_t addr, int nBit);
int clearBit(const uint32_t addr, int nBit);
int setBit(const uint32_t addr, const int nBit, int validate);
int clearBit(const uint32_t addr, const int nBit, int validate);
int getBit(const uint32_t addr, const int nBit, int *retval);
#elif GOTTHARDD
uint32_t writeRegister16And32(uint32_t offset,
uint32_t data); // FIXME its not there in ctb
void writeRegister16And32(uint32_t offset, uint32_t data);
uint32_t readRegister16And32(uint32_t offset);
#endif

6
slsDetectorServers/slsDetectorServer/src/blackfin.c
View File

@ -84,7 +84,7 @@ u_int32_t readRegister(u_int32_t offset) {
return bus_r(offset << MEM_MAP_SHIFT);
}
u_int32_t writeRegister(u_int32_t offset, u_int32_t data) {
void writeRegister(u_int32_t offset, u_int32_t data) {
// if electron mode bit touched
#ifdef JUNGFRAUD
int electronCollectionModeChange = 0;
@ -100,16 +100,14 @@ u_int32_t writeRegister(u_int32_t offset, u_int32_t data) {
configureChip();
}
#endif
return readRegister(offset);
}
u_int32_t readRegister16(u_int32_t offset) {
return (u_int32_t)bus_r16(offset << MEM_MAP_SHIFT);
}
u_int32_t writeRegister16(u_int32_t offset, u_int32_t data) {
void writeRegister16(u_int32_t offset, u_int32_t data) {
bus_w16(offset << MEM_MAP_SHIFT, (u_int16_t)data);
return readRegister16(offset);
}
int mapCSP0(void) {

5
slsDetectorServers/slsDetectorServer/src/nios.c
View File

@ -82,10 +82,7 @@ void setU64BitReg(uint64_t value, int aLSB, int aMSB) {
u_int32_t readRegister(u_int32_t offset) { return bus_r(offset); }
u_int32_t writeRegister(u_int32_t offset, u_int32_t data) {
bus_w(offset, data);
return readRegister(offset);
}
void writeRegister(u_int32_t offset, u_int32_t data) { bus_w(offset, data); }
int mapCSP0(void) {
u_int32_t csps[2] = {CSP0, CSP1};

81
slsDetectorServers/slsDetectorServer/src/slsDetectorServer_funcs.c
View File

@ -1649,40 +1649,35 @@ int get_adc(int file_des) {
int write_register(int file_des) {
ret = OK;
memset(mess, 0, sizeof(mess));
uint32_t args[2] = {-1, -1};
uint32_t retval = -1;
uint32_t args[3] = {-1, -1, -1};
if (receiveData(file_des, args, sizeof(args), INT32) < 0)
return printSocketReadError();
uint32_t addr = args[0];
uint32_t val = args[1];
LOG(logDEBUG1, ("Writing to register 0x%x, data 0x%x\n", addr, val));
uint32_t validate = args[2];
LOG(logDEBUG1, ("Writing to register 0x%x, data 0x%x, validate:%d\n", addr,
val, validate));
// only set
if (Server_VerifyLock() == OK) {
#ifdef GOTTHARDD
retval = writeRegister16And32(addr, val);
#elif EIGERD
if (writeRegister(addr, val) == FAIL) {
#if EIGERD
if (writeRegister(addr, val, validate) == FAIL) {
ret = FAIL;
sprintf(mess, "Could not write to register 0x%x.\n", addr);
LOG(logERROR, (mess));
} else {
if (readRegister(addr, &retval) == FAIL) {
ret = FAIL;
sprintf(
mess,
"Could not read register 0x%x or inconsistent values. Try "
"to read +0x100 for only left and +0x200 for only right.\n",
addr);
LOG(logERROR, (mess));
}
}
#else
retval = writeRegister(addr, val);
#ifdef GOTTHARDD
writeRegister16And32(addr, val);
uint32_t retval = readRegister16And32(addr);
#else
writeRegister(addr, val);
uint32_t retval = readRegister(addr);
#endif
LOG(logDEBUG1, ("Write register retval (0x%x): 0x%x\n", addr, retval));
// validate
if (ret == OK && retval != val) {
if (validate && ret == OK && retval != val) {
ret = FAIL;
sprintf(
mess,
@ -1690,9 +1685,9 @@ int write_register(int file_des) {
addr, val, retval);
LOG(logERROR, (mess));
}
LOG(logDEBUG1, ("Write register (0x%x): 0x%x\n", retval));
#endif
}
return Server_SendResult(file_des, INT32, &retval, sizeof(retval));
return Server_SendResult(file_des, INT32, NULL, 0);
}
int read_register(int file_des) {
@ -1707,9 +1702,7 @@ int read_register(int file_des) {
LOG(logDEBUG1, ("Reading from register 0x%x\n", addr));
// get
#ifdef GOTTHARDD
retval = readRegister16And32(addr);
#elif EIGERD
#if EIGERD
if (readRegister(addr, &retval) == FAIL) {
ret = FAIL;
sprintf(mess,
@ -1718,6 +1711,8 @@ int read_register(int file_des) {
addr);
LOG(logERROR, (mess));
}
#elif GOTTHARDD
retval = readRegister16And32(addr);
#else
retval = readRegister(addr);
#endif
@ -10594,13 +10589,15 @@ int get_frontend_firmware_version(int file_des) {
int set_bit(int file_des) {
ret = OK;
memset(mess, 0, sizeof(mess));
uint32_t args[2] = {-1, -1};
uint32_t args[3] = {-1, -1, -1};
if (receiveData(file_des, args, sizeof(args), INT32) < 0)
return printSocketReadError();
uint32_t addr = args[0];
int nBit = (int)args[1];
LOG(logDEBUG1, ("Setting bit %d of reg 0x%x\n", nBit, addr));
uint32_t validate = args[2];
LOG(logDEBUG1,
("Setting bit %d of reg 0x%x, validate:%d\n", nBit, addr, validate));
// only set
if (Server_VerifyLock() == OK) {
@ -10613,20 +10610,23 @@ int set_bit(int file_des) {
LOG(logERROR, (mess));
} else {
#ifdef EIGERD
ret = setBit(addr, nBit);
if (ret == FAIL) {
ret = setBit(addr, nBit, validate);
#else
uint32_t bitmask = (1 << nBit);
#ifdef GOTTHARDD
uint32_t val = readRegister16And32(addr) | bitmask;
uint32_t retval = writeRegister16And32(addr, val);
writeRegister16And32(addr, val);
uint32_t retval = readRegister16And32(addr) | bitmask;
#else
uint32_t val = readRegister(addr) | bitmask;
uint32_t retval = writeRegister(addr, val);
writeRegister(addr, val);
uint32_t retval = readRegister(addr) | bitmask;
#endif
if (!(retval & bitmask)) {
if (validate && (!(retval & bitmask))) {
ret = FAIL;
}
#endif
if (ret == FAIL) {
sprintf(mess, "Could not set bit %d.\n", nBit);
LOG(logERROR, (mess));
}
@ -10638,13 +10638,15 @@ int set_bit(int file_des) {
int clear_bit(int file_des) {
ret = OK;
memset(mess, 0, sizeof(mess));
uint32_t args[2] = {-1, -1};
uint32_t args[3] = {-1, -1, -1};
if (receiveData(file_des, args, sizeof(args), INT32) < 0)
return printSocketReadError();
uint32_t addr = args[0];
int nBit = (int)args[1];
LOG(logDEBUG1, ("Clearing bit %d of reg 0x%x\n", nBit, addr));
uint32_t validate = args[2];
LOG(logDEBUG1,
("Clearing bit %d of reg 0x%x, validate:%d\n", nBit, addr, validate));
// only set
if (Server_VerifyLock() == OK) {
@ -10657,20 +10659,23 @@ int clear_bit(int file_des) {
LOG(logERROR, (mess));
} else {
#ifdef EIGERD
ret = clearBit(addr, nBit);
if (ret == FAIL) {
ret = clearBit(addr, nBit, validate);
#else
uint32_t bitmask = (1 << nBit);
#ifdef GOTTHARDD
uint32_t val = readRegister16And32(addr) & ~bitmask;
uint32_t retval = writeRegister16And32(addr, val);
writeRegister16And32(addr, val);
uint32_t retval = readRegister16And32(addr) & ~bitmask;
#else
uint32_t val = readRegister(addr) & ~bitmask;
uint32_t retval = writeRegister(addr, val);
writeRegister(addr, val);
uint32_t retval = readRegister(addr) & ~bitmask;
#endif
if (retval & bitmask) {
if (validate && (retval & bitmask)) {
ret = FAIL;
}
#endif
if (ret == FAIL) {
sprintf(mess, "Could not clear bit %d.\n", nBit);
LOG(logERROR, (mess));
}

BIN
slsDetectorServers/xilinx_ctbDetectorServer/bin/xilinx_ctbDetectorServer_developer
View File

Binary file not shown.

4
slsDetectorSoftware/generator/autocomplete/autocomplete.py
View File

@ -21,8 +21,8 @@ type_values = {
"special::currentSourceFix": ["fix", "nofix"],
"special::currentSourceLow": ["normal", "low"],
"special::path": [],
"special::pedestal_parameters" : ["", "0"]
"special::pedestal_parameters" : ["", "0"],
"special::validate": ["--validate"]
}

15
slsDetectorSoftware/generator/autocomplete/bash_autocomplete.sh
View File

@ -330,6 +330,9 @@ fi
if [[ "${cword}" == "3" ]]; then
FCN_RETURN=""
fi
if [[ "${cword}" == "4" ]]; then
FCN_RETURN="--validate"
fi
fi
return 0
}
@ -342,6 +345,9 @@ fi
if [[ "${cword}" == "3" ]]; then
FCN_RETURN=""
fi
if [[ "${cword}" == "4" ]]; then
FCN_RETURN="--validate"
fi
fi
return 0
}
@ -1814,6 +1820,9 @@ fi
if [[ "${cword}" == "3" ]]; then
FCN_RETURN=""
fi
if [[ "${cword}" == "4" ]]; then
FCN_RETURN="--validate"
fi
fi
return 0
}
@ -1826,6 +1835,9 @@ fi
if [[ "${cword}" == "3" ]]; then
FCN_RETURN=""
fi
if [[ "${cword}" == "4" ]]; then
FCN_RETURN="--validate"
fi
fi
if [[ ${IS_GET} -eq 0 ]]; then
if [[ "${cword}" == "2" ]]; then
@ -2211,6 +2223,9 @@ fi
if [[ "${cword}" == "3" ]]; then
FCN_RETURN=""
fi
if [[ "${cword}" == "4" ]]; then
FCN_RETURN="--validate"
fi
fi
return 0
}

15
slsDetectorSoftware/generator/autocomplete/zsh_autocomplete.sh
View File

@ -254,6 +254,9 @@ fi
if [[ "${cword}" == "3" ]]; then
FCN_RETURN=""
fi
if [[ "${cword}" == "4" ]]; then
FCN_RETURN="--validate"
fi
fi
return 0
}
@ -266,6 +269,9 @@ fi
if [[ "${cword}" == "3" ]]; then
FCN_RETURN=""
fi
if [[ "${cword}" == "4" ]]; then
FCN_RETURN="--validate"
fi
fi
return 0
}
@ -1738,6 +1744,9 @@ fi
if [[ "${cword}" == "3" ]]; then
FCN_RETURN=""
fi
if [[ "${cword}" == "4" ]]; then
FCN_RETURN="--validate"
fi
fi
return 0
}
@ -1750,6 +1759,9 @@ fi
if [[ "${cword}" == "3" ]]; then
FCN_RETURN=""
fi
if [[ "${cword}" == "4" ]]; then
FCN_RETURN="--validate"
fi
fi
if [[ ${IS_GET} -eq 0 ]]; then
if [[ "${cword}" == "2" ]]; then
@ -2135,6 +2147,9 @@ fi
if [[ "${cword}" == "3" ]]; then
FCN_RETURN=""
fi
if [[ "${cword}" == "4" ]]; then
FCN_RETURN="--validate"
fi
fi
return 0
}

53
slsDetectorSoftware/generator/commands.yaml
View File

@ -4173,7 +4173,7 @@ update:
output: [ '"successful"' ]
reg:
help: "[address] [32 bit value]\n\t[Mythen3][Gotthard2] Reads/writes to a 32 bit register in hex. Advanced Function!\n\tGoes to stop server. Hence, can be called while calling blocking acquire().\n\t[Eiger] +0x100 for only left, +0x200 for only right."
help: "[address] [32 bit value][(optional)--validate]\n\t[Mythen3][Gotthard2] Reads/writes to a 32 bit register in hex. Advanced Function!\n\tGoes to stop server. Hence, can be called while calling blocking acquire().\n\t\t Use --validate to force validation when writing to it.\n\t[Eiger] +0x100 for only left, +0x200 for only right."
actions:
GET:
argc: 1
@ -4184,13 +4184,23 @@ reg:
cast_input: [ true ]
output: [ OutStringHex(t) ]
PUT:
argc: 2
require_det_id: true
function: writeRegister
input: [ 'args[0]', 'args[1]' ]
input_types: [ uint32_t, uint32_t ]
cast_input: [ true, true ]
output: [ ToString(args) ]
output: [ '"["', 'args[0]', '", "', 'args[1]', '"]"' ]
args:
- argc: 2
input: [ 'args[0]', 'args[1]', '"0"' ]
input_types: [ uint32_t, uint32_t, bool ]
arg_types: [ uint32_t, uint32_t ]
cast_input: [ true, true, true ]
- argc: 3
arg_types: [ uint32_t, uint32_t, special::validate ]
exceptions:
- condition: 'args[2] != "--validate"'
message: '"Could not scan third argument. Did you mean --validate?"'
input: [ 'args[0]', 'args[1]', '"1"' ]
input_types: [ uint32_t, uint32_t, bool ]
cast_input: [ true, true, true ]
adcreg:
help: "[address] [value]\n\t[Jungfrau][Moench][Ctb][Gotthard] Writes to an adc register in hex. Advanced user Function!"
@ -4223,27 +4233,40 @@ Setbit:
template: true
actions:
PUT:
argc: 2
require_det_id: true
function: setBit
output: [ '"["', 'args[0]', '", "', 'args[1]', '"]"' ]
args:
- argc: 2
exceptions:
- condition: 'StringTo<int>(args[1]) < 0 || StringTo<int>(args[1]) > 31'
message: '"Bit number out of range: " + args[1]'
require_det_id: true
function: setBit
input: [ 'args[0]', 'args[1]' ]
input_types: [ uint32_t, int ]
cast_input: [ true, true ]
output: [ ToString(args) ]
input: [ 'args[0]', 'args[1]', '"0"' ]
input_types: [ uint32_t, int, bool ]
arg_types: [ uint32_t, int ]
cast_input: [ true, true, true ]
- argc: 3
arg_types: [ uint32_t, int, special::validate ]
exceptions:
- condition: 'StringTo<int>(args[1]) < 0 || StringTo<int>(args[1]) > 31'
message: '"Bit number out of range: " + args[1]'
- condition: 'args[2] != "--validate"'
message: '"Could not scan third argument. Did you mean --validate?"'
input: [ 'args[0]', 'args[1]', '"1"' ]
input_types: [ uint32_t, int, bool ]
cast_input: [ true, true, true ]
setbit:
inherit_actions: Setbit
help: "[reg address in hex] [bit index]\n\tSets bit in address."
help: "[reg address in hex] [bit index]\n\tSets bit in address.\n\tUse --validate to force validation."
actions:
PUT:
function: setBit
clearbit:
inherit_actions: Setbit
help: "[reg address in hex] [bit index]\n\tClears bit in address."
help: "[reg address in hex] [bit index]\n\tClears bit in address.\n\tUse --validate to force validation."
actions:
PUT:
function: clearBit

139
slsDetectorSoftware/generator/extended_commands.yaml
View File

@ -1104,6 +1104,7 @@ clearbit:
cast_input:
- true
- true
- true
check_det_id: false
convert_det_id: true
exceptions:
@ -1113,16 +1114,56 @@ clearbit:
input:
- args[0]
- args[1]
- '"0"'
input_types:
- uint32_t
- int
- bool
output:
- ToString(args)
- '"["'
- args[0]
- '", "'
- args[1]
- '"]"'
require_det_id: true
store_result_in_t: false
- arg_types:
- uint32_t
- int
- special::validate
argc: 3
cast_input:
- true
- true
- true
check_det_id: false
convert_det_id: true
exceptions:
- condition: StringTo<int>(args[1]) < 0 || StringTo<int>(args[1]) > 31
message: '"Bit number out of range: " + args[1]'
- condition: args[2] != "--validate"
message: '"Could not scan third argument. Did you mean --validate?"'
function: clearBit
input:
- args[0]
- args[1]
- '"1"'
input_types:
- uint32_t
- int
- bool
output:
- '"["'
- args[0]
- '", "'
- args[1]
- '"]"'
require_det_id: true
store_result_in_t: false
command_name: clearbit
function_alias: clearbit
help: "[reg address in hex] [bit index]\n\tClears bit in address."
help: "[reg address in hex] [bit index]\n\tClears bit in address.\n\tUse --validate\
\ to force validation."
infer_action: true
template: true
clearbusy:
@ -7973,25 +8014,64 @@ reg:
cast_input:
- true
- true
- true
check_det_id: false
convert_det_id: true
function: writeRegister
input:
- args[0]
- args[1]
- '"0"'
input_types:
- uint32_t
- uint32_t
- bool
output:
- ToString(args)
- '"["'
- args[0]
- '", "'
- args[1]
- '"]"'
require_det_id: true
store_result_in_t: false
- arg_types:
- uint32_t
- uint32_t
- special::validate
argc: 3
cast_input:
- true
- true
- true
check_det_id: false
convert_det_id: true
exceptions:
- condition: args[2] != "--validate"
message: '"Could not scan third argument. Did you mean --validate?"'
function: writeRegister
input:
- args[0]
- args[1]
- '"1"'
input_types:
- uint32_t
- uint32_t
- bool
output:
- '"["'
- args[0]
- '", "'
- args[1]
- '"]"'
require_det_id: true
store_result_in_t: false
command_name: reg
function_alias: reg
help: "[address] [32 bit value]\n\t[Mythen3][Gotthard2] Reads/writes to a 32 bit\
\ register in hex. Advanced Function!\n\tGoes to stop server. Hence, can be called\
\ while calling blocking acquire().\n\t[Eiger] +0x100 for only left, +0x200 for\
\ only right."
help: "[address] [32 bit value][(optional)--validate]\n\t[Mythen3][Gotthard2] Reads/writes\
\ to a 32 bit register in hex. Advanced Function!\n\tGoes to stop server. Hence,\
\ can be called while calling blocking acquire().\n\t\t Use --validate to force\
\ validation when writing to it.\n\t[Eiger] +0x100 for only left, +0x200 for only\
\ right."
infer_action: true
resetdacs:
actions:
@ -9646,6 +9726,7 @@ setbit:
cast_input:
- true
- true
- true
check_det_id: false
convert_det_id: true
exceptions:
@ -9655,16 +9736,56 @@ setbit:
input:
- args[0]
- args[1]
- '"0"'
input_types:
- uint32_t
- int
- bool
output:
- ToString(args)
- '"["'
- args[0]
- '", "'
- args[1]
- '"]"'
require_det_id: true
store_result_in_t: false
- arg_types:
- uint32_t
- int
- special::validate
argc: 3
cast_input:
- true
- true
- true
check_det_id: false
convert_det_id: true
exceptions:
- condition: StringTo<int>(args[1]) < 0 || StringTo<int>(args[1]) > 31
message: '"Bit number out of range: " + args[1]'
- condition: args[2] != "--validate"
message: '"Could not scan third argument. Did you mean --validate?"'
function: setBit
input:
- args[0]
- args[1]
- '"1"'
input_types:
- uint32_t
- int
- bool
output:
- '"["'
- args[0]
- '", "'
- args[1]
- '"]"'
require_det_id: true
store_result_in_t: false
command_name: setbit
function_alias: setbit
help: "[reg address in hex] [bit index]\n\tSets bit in address."
help: "[reg address in hex] [bit index]\n\tSets bit in address.\n\tUse --validate\
\ to force validation."
infer_action: true
template: true
settings:

9
slsDetectorSoftware/include/sls/Detector.h
View File

@ -2034,13 +2034,16 @@ class Detector {
* Goes to stop server. Hence, can be called while calling blocking
* acquire(). \n [Eiger] Address is +0x100 for only left, +0x200 for only
* right. */
void writeRegister(uint32_t addr, uint32_t val, Positions pos = {});
void writeRegister(uint32_t addr, uint32_t val, bool validate = false,
Positions pos = {});
/** Advanced user Function! */
void setBit(uint32_t addr, int bitnr, Positions pos = {});
void setBit(uint32_t addr, int bitnr, bool validate = false,
Positions pos = {});
/** Advanced user Function! */
void clearBit(uint32_t addr, int bitnr, Positions pos = {});
void clearBit(uint32_t addr, int bitnr, bool validate = false,
Positions pos = {});
/** Advanced user Function! */
Result<int> getBit(uint32_t addr, int bitnr, Positions pos = {});

141
slsDetectorSoftware/src/Caller.cpp
View File

@ -1482,14 +1482,15 @@ std::string Caller::clearbit(int action) {
if (action == slsDetectorDefs::HELP_ACTION) {
os << "Command: clearbit" << std::endl;
os << R"V0G0N([reg address in hex] [bit index]
Clears bit in address. )V0G0N"
Clears bit in address.
Use --validate to force validation. )V0G0N"
<< std::endl;
return os.str();
}
// check if action and arguments are valid
if (action == slsDetectorDefs::PUT_ACTION) {
if (1 && args.size() != 2) {
if (1 && args.size() != 2 && args.size() != 3) {
throw RuntimeError("Wrong number of arguments for action PUT");
}
@ -1504,6 +1505,29 @@ std::string Caller::clearbit(int action) {
} catch (...) {
throw RuntimeError("Could not convert argument 1 to int");
}
try {
StringTo<bool>("0");
} catch (...) {
throw RuntimeError("Could not convert argument 2 to bool");
}
}
if (args.size() == 3) {
try {
StringTo<uint32_t>(args[0]);
} catch (...) {
throw RuntimeError("Could not convert argument 0 to uint32_t");
}
try {
StringTo<int>(args[1]);
} catch (...) {
throw RuntimeError("Could not convert argument 1 to int");
}
try {
StringTo<bool>("1");
} catch (...) {
throw RuntimeError("Could not convert argument 2 to bool");
}
}
}
@ -1522,8 +1546,24 @@ std::string Caller::clearbit(int action) {
}
auto arg0 = StringTo<uint32_t>(args[0]);
auto arg1 = StringTo<int>(args[1]);
det->clearBit(arg0, arg1, std::vector<int>{det_id});
os << ToString(args) << '\n';
auto arg2 = StringTo<bool>("0");
det->clearBit(arg0, arg1, arg2, std::vector<int>{det_id});
os << "[" << args[0] << ", " << args[1] << "]" << '\n';
}
if (args.size() == 3) {
if (StringTo<int>(args[1]) < 0 || StringTo<int>(args[1]) > 31) {
throw RuntimeError("Bit number out of range: " + args[1]);
}
if (args[2] != "--validate") {
throw RuntimeError(
"Could not scan third argument. Did you mean --validate?");
}
auto arg0 = StringTo<uint32_t>(args[0]);
auto arg1 = StringTo<int>(args[1]);
auto arg2 = StringTo<bool>("1");
det->clearBit(arg0, arg1, arg2, std::vector<int>{det_id});
os << "[" << args[0] << ", " << args[1] << "]" << '\n';
}
}
@ -10307,9 +10347,10 @@ std::string Caller::reg(int action) {
// print help
if (action == slsDetectorDefs::HELP_ACTION) {
os << "Command: reg" << std::endl;
os << R"V0G0N([address] [32 bit value]
os << R"V0G0N([address] [32 bit value][(optional)--validate]
[Mythen3][Gotthard2] Reads/writes to a 32 bit register in hex. Advanced Function!
Goes to stop server. Hence, can be called while calling blocking acquire().
Use --validate to force validation when writing to it.
[Eiger] +0x100 for only left, +0x200 for only right. )V0G0N"
<< std::endl;
return os.str();
@ -10332,7 +10373,7 @@ std::string Caller::reg(int action) {
}
else if (action == slsDetectorDefs::PUT_ACTION) {
if (1 && args.size() != 2) {
if (1 && args.size() != 2 && args.size() != 3) {
throw RuntimeError("Wrong number of arguments for action PUT");
}
@ -10347,6 +10388,29 @@ std::string Caller::reg(int action) {
} catch (...) {
throw RuntimeError("Could not convert argument 1 to uint32_t");
}
try {
StringTo<bool>("0");
} catch (...) {
throw RuntimeError("Could not convert argument 2 to bool");
}
}
if (args.size() == 3) {
try {
StringTo<uint32_t>(args[0]);
} catch (...) {
throw RuntimeError("Could not convert argument 0 to uint32_t");
}
try {
StringTo<uint32_t>(args[1]);
} catch (...) {
throw RuntimeError("Could not convert argument 1 to uint32_t");
}
try {
StringTo<bool>("1");
} catch (...) {
throw RuntimeError("Could not convert argument 2 to bool");
}
}
}
@ -10370,8 +10434,21 @@ std::string Caller::reg(int action) {
if (args.size() == 2) {
auto arg0 = StringTo<uint32_t>(args[0]);
auto arg1 = StringTo<uint32_t>(args[1]);
det->writeRegister(arg0, arg1, std::vector<int>{det_id});
os << ToString(args) << '\n';
auto arg2 = StringTo<bool>("0");
det->writeRegister(arg0, arg1, arg2, std::vector<int>{det_id});
os << "[" << args[0] << ", " << args[1] << "]" << '\n';
}
if (args.size() == 3) {
if (args[2] != "--validate") {
throw RuntimeError(
"Could not scan third argument. Did you mean --validate?");
}
auto arg0 = StringTo<uint32_t>(args[0]);
auto arg1 = StringTo<uint32_t>(args[1]);
auto arg2 = StringTo<bool>("1");
det->writeRegister(arg0, arg1, arg2, std::vector<int>{det_id});
os << "[" << args[0] << ", " << args[1] << "]" << '\n';
}
}
@ -12601,14 +12678,15 @@ std::string Caller::setbit(int action) {
if (action == slsDetectorDefs::HELP_ACTION) {
os << "Command: setbit" << std::endl;
os << R"V0G0N([reg address in hex] [bit index]
Sets bit in address. )V0G0N"
Sets bit in address.
Use --validate to force validation. )V0G0N"
<< std::endl;
return os.str();
}
// check if action and arguments are valid
if (action == slsDetectorDefs::PUT_ACTION) {
if (1 && args.size() != 2) {
if (1 && args.size() != 2 && args.size() != 3) {
throw RuntimeError("Wrong number of arguments for action PUT");
}
@ -12623,6 +12701,29 @@ std::string Caller::setbit(int action) {
} catch (...) {
throw RuntimeError("Could not convert argument 1 to int");
}
try {
StringTo<bool>("0");
} catch (...) {
throw RuntimeError("Could not convert argument 2 to bool");
}
}
if (args.size() == 3) {
try {
StringTo<uint32_t>(args[0]);
} catch (...) {
throw RuntimeError("Could not convert argument 0 to uint32_t");
}
try {
StringTo<int>(args[1]);
} catch (...) {
throw RuntimeError("Could not convert argument 1 to int");
}
try {
StringTo<bool>("1");
} catch (...) {
throw RuntimeError("Could not convert argument 2 to bool");
}
}
}
@ -12641,8 +12742,24 @@ std::string Caller::setbit(int action) {
}
auto arg0 = StringTo<uint32_t>(args[0]);
auto arg1 = StringTo<int>(args[1]);
det->setBit(arg0, arg1, std::vector<int>{det_id});
os << ToString(args) << '\n';
auto arg2 = StringTo<bool>("0");
det->setBit(arg0, arg1, arg2, std::vector<int>{det_id});
os << "[" << args[0] << ", " << args[1] << "]" << '\n';
}
if (args.size() == 3) {
if (StringTo<int>(args[1]) < 0 || StringTo<int>(args[1]) > 31) {
throw RuntimeError("Bit number out of range: " + args[1]);
}
if (args[2] != "--validate") {
throw RuntimeError(
"Could not scan third argument. Did you mean --validate?");
}
auto arg0 = StringTo<uint32_t>(args[0]);
auto arg1 = StringTo<int>(args[1]);
auto arg2 = StringTo<bool>("1");
det->setBit(arg0, arg1, arg2, std::vector<int>{det_id});
os << "[" << args[0] << ", " << args[1] << "]" << '\n';
}
}

14
slsDetectorSoftware/src/Detector.cpp
View File

@ -2673,16 +2673,18 @@ Result<uint32_t> Detector::readRegister(uint32_t addr, Positions pos) const {
return pimpl->Parallel(&Module::readRegister, pos, addr);
}
void Detector::writeRegister(uint32_t addr, uint32_t val, Positions pos) {
pimpl->Parallel(&Module::writeRegister, pos, addr, val);
void Detector::writeRegister(uint32_t addr, uint32_t val, bool validate,
Positions pos) {
pimpl->Parallel(&Module::writeRegister, pos, addr, val, validate);
}
void Detector::setBit(uint32_t addr, int bitnr, Positions pos) {
pimpl->Parallel(&Module::setBit, pos, addr, bitnr);
void Detector::setBit(uint32_t addr, int bitnr, bool validate, Positions pos) {
pimpl->Parallel(&Module::setBit, pos, addr, bitnr, validate);
}
void Detector::clearBit(uint32_t addr, int bitnr, Positions pos) {
pimpl->Parallel(&Module::clearBit, pos, addr, bitnr);
void Detector::clearBit(uint32_t addr, int bitnr, bool validate,
Positions pos) {
pimpl->Parallel(&Module::clearBit, pos, addr, bitnr, validate);
}
Result<int> Detector::getBit(uint32_t addr, int bitnr, Positions pos) {

16
slsDetectorSoftware/src/Module.cpp
View File

@ -2812,18 +2812,20 @@ uint32_t Module::readRegister(uint32_t addr) const {
return sendToDetectorStop<uint32_t>(F_READ_REGISTER, addr);
}
uint32_t Module::writeRegister(uint32_t addr, uint32_t val) {
uint32_t args[]{addr, val};
return sendToDetectorStop<uint32_t>(F_WRITE_REGISTER, args);
void Module::writeRegister(uint32_t addr, uint32_t val, bool validate) {
uint32_t args[]{addr, val, static_cast<uint32_t>(validate)};
return sendToDetectorStop(F_WRITE_REGISTER, args, nullptr);
}
void Module::setBit(uint32_t addr, int n) {
uint32_t args[2] = {addr, static_cast<uint32_t>(n)};
void Module::setBit(uint32_t addr, int n, bool validate) {
uint32_t args[] = {addr, static_cast<uint32_t>(n),
static_cast<uint32_t>(validate)};
sendToDetectorStop(F_SET_BIT, args, nullptr);
}
void Module::clearBit(uint32_t addr, int n) {
uint32_t args[2] = {addr, static_cast<uint32_t>(n)};
void Module::clearBit(uint32_t addr, int n, bool validate) {
uint32_t args[] = {addr, static_cast<uint32_t>(n),
static_cast<uint32_t>(validate)};
sendToDetectorStop(F_CLEAR_BIT, args, nullptr);
}

6
slsDetectorSoftware/src/Module.h
View File

@ -589,9 +589,9 @@ class Module : public virtual slsDetectorDefs {
bool getUpdateMode() const;
void setUpdateMode(const bool updatemode);
uint32_t readRegister(uint32_t addr) const;
uint32_t writeRegister(uint32_t addr, uint32_t val);
void setBit(uint32_t addr, int n);
void clearBit(uint32_t addr, int n);
void writeRegister(uint32_t addr, uint32_t val, bool validate);
void setBit(uint32_t addr, int n, bool validate);
void clearBit(uint32_t addr, int n, bool validate);
int getBit(uint32_t addr, int n);
void executeFirmwareTest();
void executeBusTest();

12
slsDetectorSoftware/src/inferAction.cpp
View File

@ -404,6 +404,10 @@ int InferAction::clearbit() {
return slsDetectorDefs::PUT_ACTION;
}
if (args.size() == 3) {
return slsDetectorDefs::PUT_ACTION;
}
else {
throw RuntimeError("Could not infer action: Wrong number of arguments");
@ -2490,6 +2494,10 @@ int InferAction::reg() {
return slsDetectorDefs::PUT_ACTION;
}
if (args.size() == 3) {
return slsDetectorDefs::PUT_ACTION;
}
else {
throw RuntimeError("Could not infer action: Wrong number of arguments");
@ -3143,6 +3151,10 @@ int InferAction::setbit() {
return slsDetectorDefs::PUT_ACTION;
}
if (args.size() == 3) {
return slsDetectorDefs::PUT_ACTION;
}
else {
throw RuntimeError("Could not infer action: Wrong number of arguments");

33
slsDetectorSoftware/tests/Caller/test-Caller.cpp
View File

@ -3245,6 +3245,13 @@ TEST_CASE("CALLER::reg", "[.cmdcall]") {
uint32_t addr = 0x64;
std::string saddr = ToStringHex(addr);
auto prev_val = det.readRegister(addr);
{
std::ostringstream oss1, oss2;
caller.call("reg", {saddr, "0x6", "--validate"}, -1, PUT, oss1);
REQUIRE(oss1.str() == "reg [" + saddr + ", 0x6]\n");
caller.call("reg", {saddr}, -1, GET, oss2);
REQUIRE(oss2.str() == "reg 0x6\n");
}
{
std::ostringstream oss1, oss2;
caller.call("reg", {saddr, "0x5"}, -1, PUT, oss1);
@ -3253,7 +3260,7 @@ TEST_CASE("CALLER::reg", "[.cmdcall]") {
REQUIRE(oss2.str() == "reg 0x5\n");
}
for (int i = 0; i != det.size(); ++i) {
det.writeRegister(addr, prev_val[i], {i});
det.writeRegister(addr, prev_val[i], false, {i});
}
}
// cannot check for eiger virtual server
@ -3289,15 +3296,17 @@ TEST_CASE("CALLER::setbit", "[.cmdcall]") {
std::string saddr = ToStringHex(addr);
auto prev_val = det.readRegister(addr);
{
std::ostringstream oss1, oss2;
std::ostringstream oss1, oss2, oss3;
caller.call("reg", {saddr, "0x0"}, -1, PUT);
caller.call("setbit", {saddr, "1"}, -1, PUT, oss1);
REQUIRE(oss1.str() == "setbit [" + saddr + ", 1]\n");
caller.call("reg", {saddr}, -1, GET, oss2);
REQUIRE(oss2.str() == "reg 0x2\n");
caller.call("setbit", {saddr, "2", "--validate"}, -1, PUT, oss2);
REQUIRE(oss2.str() == "setbit [" + saddr + ", 2]\n");
caller.call("reg", {saddr}, -1, GET, oss3);
REQUIRE(oss3.str() == "reg 0x6\n");
}
for (int i = 0; i != det.size(); ++i) {
det.writeRegister(addr, prev_val[i], {i});
det.writeRegister(addr, prev_val[i], false, {i});
}
}
}
@ -3311,15 +3320,17 @@ TEST_CASE("CALLER::clearbit", "[.cmdcall]") {
std::string saddr = ToStringHex(addr);
auto prev_val = det.readRegister(addr);
{
std::ostringstream oss1, oss2;
caller.call("reg", {saddr, "0x3"}, -1, PUT);
std::ostringstream oss1, oss2, oss3;
caller.call("reg", {saddr, "0x7"}, -1, PUT);
caller.call("clearbit", {saddr, "1"}, -1, PUT, oss1);
REQUIRE(oss1.str() == "clearbit [" + saddr + ", 1]\n");
caller.call("reg", {saddr}, -1, GET, oss2);
REQUIRE(oss2.str() == "reg 0x1\n");
caller.call("clearbit", {saddr, "2", "--validate"}, -1, PUT, oss2);
REQUIRE(oss2.str() == "clearbit [" + saddr + ", 2]\n");
caller.call("reg", {saddr}, -1, GET, oss3);
REQUIRE(oss3.str() == "reg 0x1\n");
}
for (int i = 0; i != det.size(); ++i) {
det.writeRegister(addr, prev_val[i], {i});
det.writeRegister(addr, prev_val[i], false, {i});
}
}
}
@ -3339,7 +3350,7 @@ TEST_CASE("CALLER::getbit", "[.cmdcall]") {
REQUIRE(oss1.str() == "getbit 1\n");
}
for (int i = 0; i != det.size(); ++i) {
det.writeRegister(addr, prev_val[i], {i});
det.writeRegister(addr, prev_val[i], false, {i});
}
}
// cannot check for eiger virtual server

16
slsSupportLib/include/sls/versionAPI.h
View File

@ -4,11 +4,11 @@
#define RELEASE "developer"
#define APILIB "developer 0x230224"
#define APIRECEIVER "developer 0x230224"
#define APICTB "developer 0x240910"
#define APIGOTTHARD "developer 0x240910"
#define APIGOTTHARD2 "developer 0x240910"
#define APIJUNGFRAU "developer 0x240910"
#define APIMYTHEN3 "developer 0x240910"
#define APIMOENCH "developer 0x240910"
#define APIXILINXCTB "developer 0x240910"
#define APIEIGER "developer 0x240910"
#define APICTB "developer 0x240918"
#define APIGOTTHARD "developer 0x240918"
#define APIGOTTHARD2 "developer 0x240918"
#define APIJUNGFRAU "developer 0x240918"
#define APIMYTHEN3 "developer 0x240918"
#define APIMOENCH "developer 0x240918"
#define APIXILINXCTB "developer 0x240918"
#define APIEIGER "developer 0x240918"