| CAEN FERS Library v1.1.4 SDK for FERS systems

Enumerations
Enumerations

Application enumerations. More...

## Enumerations
enum | FERSLIB_RxThreadSatatus { RXSTATUS_OFF = 0 , RXSTATUS_IDLE = 1 , RXSTATUS_RUNNING = 2 , RXSTATUS_EMPTYING = 3 }
| Status of the data RX thread. More...
enum | FERSLIB_ReadoutStatus { ROSTATUS_IDLE = 0 , ROSTATUS_RUNNING = 1 , ROSTATUS_EMPTYING = 2 , ROSTATUS_FLUSHING = 3 , RAWDATA_REPROCESS_FINISHED = 4 }
| Readout status. More...
enum | FERSLIB_ErrorCodes { FERSLIB_SUCCESS = 0 , FERSLIB_ERR_GENERIC = -1 , FERSLIB_ERR_COMMUNICATION = -2 , FERSLIB_ERR_MAX_NBOARD_REACHED = -3 , FERSLIB_ERR_DEVICE_ALREADY_OPENED = -4 , FERSLIB_ERR_INVALID_PATH = -5 , FERSLIB_ERR_INVALID_HANDLE = -6 , FERSLIB_ERR_READOUT_ERROR = -7 , FERSLIB_ERR_MALLOC_BUFFERS = -8 , FERSLIB_ERR_INVALID_BIC = -9 , FERSLIB_ERR_READOUT_NOT_INIT = -10 , FERSLIB_ERR_CALIB_NOT_FOUND = -11 , FERSLIB_ERR_PEDCALIB_NOT_FOUND = -11 , FERSLIB_ERR_INVALID_FWFILE = -12 , FERSLIB_ERR_UPGRADE_ERROR = -13 , FERSLIB_ERR_INVALID_PARAM = -14 , FERSLIB_ERR_NOT_APPLICABLE = -15 , FERSLIB_ERR_TDL_ERROR = -16 , FERSLIB_ERR_QUEUE_OVERRUN = -17 , FERSLIB_ERR_START_STOP_ERROR = -18 , FERSLIB_ERR_OPER_NOT_ALLOWED = -19 , FERSLIB_ERR_INVALID_CLK_SETTING = -20 , FERSLIB_ERR_TDL_CHAIN_BROKEN = -21 , FERSLIB_ERR_TDL_CHAIN_DOWN = -22 , FERSLIB_ERR_I2C_NACK = -23 , FERSLIB_ERR_CALIB_FAIL = -24 , FERSLIB_ERR_INVALID_FW = -25 , FERSLIB_ERR_INVALID_PARAM_VALUE = -26 , FERSLIB_ERR_INVALID_PARAM_UNIT = -27 }
| Error codes. More...
enum | FERSLIB_EvtBuildingModes { ROMODE_DISABLE_SORTING = 0x0000 , ROMODE_TRGTIME_SORTING = 0x0001 , ROMODE_TRGID_SORTING = 0x0002 }
| Event Building modes. More...
enum | FERSLIB_ServEventsMode { SE_HV = 1 , SE_COUNT = 2 , SE_ALL = 3 }
| Service event Modes. More...
enum | FERSLIB_StartMode { STARTRUN_ASYNC = 0 , STARTRUN_CHAIN_T0 = 1 , STARTRUN_CHAIN_T1 = 2 , STARTRUN_TDL = 3 }
| Start/Stop modes. More...
enum | FERSLIB_GlitchFilterModes { GLITCHFILTERMODE_DISABLED = 0 , GLITCHFILTERMODE_TRAILING = 1 , GLITCHFILTERMODE_LEADING = 2 , GLITCHFILTERMODE_BOTH = 3 }
| Glitch filter modes. More...
enum | FERSLIB_HRClockModes { HRCLK_DISABLED = 0 , HRCLK_DAISY_CHAIN = 1 , HRCLK_FAN_OUT = 2 }
| High resolution clock modes. More...

## Detailed Description

Application enumerations.

## Enumeration Type Documentation

## ◆ FERSLIB_RxThreadSatatus

enum FERSLIB_RxThreadSatatus

Status of the data RX thread.

Enumerator
RXSTATUS_OFF |
RXSTATUS_IDLE |
RXSTATUS_RUNNING |
RXSTATUS_EMPTYING |

Definition at line 159 of file FERSlib.h.

## ◆ FERSLIB_ReadoutStatus

enum FERSLIB_ReadoutStatus

Readout status.

Enumerator
ROSTATUS_IDLE | idle (acquisition not running)
ROSTATUS_RUNNING | running (data readout)
ROSTATUS_EMPTYING | boards stopped, reading last data in the pipes
ROSTATUS_FLUSHING | flushing old data (clear)
RAWDATA_REPROCESS_FINISHED | end of offline raw data reprocessing

Definition at line 170 of file FERSlib.h.

## ◆ FERSLIB_ErrorCodes

enum FERSLIB_ErrorCodes

Error codes.

Enumerator
FERSLIB_SUCCESS | Operation completed succesfully
FERSLIB_ERR_GENERIC | Generic error
FERSLIB_ERR_COMMUNICATION | Communication error
FERSLIB_ERR_MAX_NBOARD_REACHED | Maximum number of devices supported exceeded
FERSLIB_ERR_DEVICE_ALREADY_OPENED |
FERSLIB_ERR_INVALID_PATH | <Device already opened Invalid file/address path provided
FERSLIB_ERR_INVALID_HANDLE | Invalid handle used
FERSLIB_ERR_READOUT_ERROR | Readout error
FERSLIB_ERR_MALLOC_BUFFERS | Failed to allocate memory for buffers
FERSLIB_ERR_INVALID_BIC | Invalid BIC (Board Interface Controller) detected
FERSLIB_ERR_READOUT_NOT_INIT | Readout buffers not initialized
FERSLIB_ERR_CALIB_NOT_FOUND | Calibration data for A5256 not found
FERSLIB_ERR_PEDCALIB_NOT_FOUND | Pedestal calibration data in flash not found
FERSLIB_ERR_INVALID_FWFILE | Invalid firmware file provided
FERSLIB_ERR_UPGRADE_ERROR | Firmware upgrade failed
FERSLIB_ERR_INVALID_PARAM | Invalid parameter name provided
FERSLIB_ERR_NOT_APPLICABLE | Operation not applicable on the current FERS module family
FERSLIB_ERR_TDL_ERROR | Error generated during enum, sync or reset through TDL
FERSLIB_ERR_QUEUE_OVERRUN | Readout event-bulding queue overrun occurred during operation
FERSLIB_ERR_START_STOP_ERROR | Start or stop operation failed
FERSLIB_ERR_OPER_NOT_ALLOWED | Operation not allowed in the current state
FERSLIB_ERR_INVALID_CLK_SETTING | Invalid High resolution clock settings provided
FERSLIB_ERR_TDL_CHAIN_BROKEN | TDL chain broken detected
FERSLIB_ERR_TDL_CHAIN_DOWN | TDL chain down detected
FERSLIB_ERR_I2C_NACK | I2C NACK received
FERSLIB_ERR_CALIB_FAIL | A5256 threshold calibration process failed
FERSLIB_ERR_INVALID_FW | Invalid firmware detected
FERSLIB_ERR_INVALID_PARAM_VALUE | Invalid parameter value provided
FERSLIB_ERR_INVALID_PARAM_UNIT | Invalid parameter unit specified

Definition at line 182 of file FERSlib.h.

## ◆ FERSLIB_EvtBuildingModes

enum FERSLIB_EvtBuildingModes

Event Building modes.

Enumerator
ROMODE_DISABLE_SORTING | Disable sorting
ROMODE_TRGTIME_SORTING | Enable event sorting by Trigger Tstamp
ROMODE_TRGID_SORTING | Enable event sorting by Trigger ID

Definition at line 255 of file FERSlib.h.

## ◆ FERSLIB_ServEventsMode

enum FERSLIB_ServEventsMode

Service event Modes.

Enumerator
SE_HV | Only Hv data
SE_COUNT | Only counter data
SE_ALL | Hv + Counter data

Definition at line 265 of file FERSlib.h.

## ◆ FERSLIB_StartMode

enum FERSLIB_StartMode

Start/Stop modes.

Enumerator
STARTRUN_ASYNC | Run start sent to each board individually
STARTRUN_CHAIN_T0 | Run start sent to board 0 and propagate in daisy chain through T0-out/T0-in
STARTRUN_CHAIN_T1 | Run start sent to board 0 and propagate in daisy chain through T1-out-T1-in
STARTRUN_TDL | Run start sent thorugh concentrator to all board in sync

Definition at line 336 of file FERSlib.h.

## ◆ FERSLIB_GlitchFilterModes

enum FERSLIB_GlitchFilterModes

Glitch filter modes.

Enumerator
GLITCHFILTERMODE_DISABLED |
GLITCHFILTERMODE_TRAILING |
GLITCHFILTERMODE_LEADING |
GLITCHFILTERMODE_BOTH |

Definition at line 372 of file FERSlib.h.

## ◆ FERSLIB_HRClockModes

enum FERSLIB_HRClockModes

High resolution clock modes.

Enumerator
HRCLK_DISABLED |
HRCLK_DAISY_CHAIN |
HRCLK_FAN_OUT |

Definition at line 384 of file FERSlib.h.