#pragma once /************************************************ * @file sls_detector_defs.h * @short contains all the constants, enum definitions and enum-string *conversions ***********************************************/ /** *@short contains all the constants, enum definitions and enum-string *conversions */ #ifdef __CINT__ #define MYROOT #define __cplusplus #endif #include #ifdef __cplusplus #include "sls_detector_exceptions.h" #include #include #include #endif #include "ansi.h" #define BIT32_MASK 0xFFFFFFFF #define MAX_RX_DBIT 64 /** default ports */ #define DEFAULT_PORTNO 1952 #define DEFAULT_UDP_PORTNO 50001 #define DEFAULT_ZMQ_CL_PORTNO 30001 #define DEFAULT_ZMQ_RX_PORTNO 30001 #define SLS_DETECTOR_HEADER_VERSION 0x2 #define SLS_DETECTOR_JSON_HEADER_VERSION 0x3 // ctb/ moench 1g udp (read from fifo) #define UDP_PACKET_DATA_BYTES (1344) /** maximum rois */ #define MAX_ROIS 100 /** maximum trim en */ #define MAX_TRIMEN 100 /** maximum unit size of program sent to detector */ #define MAX_FPGAPROGRAMSIZE (2 * 1024 * 1024) /** get flag form most functions */ #define GET_FLAG -1 #define DEFAULT_DET_MAC "00:aa:bb:cc:dd:ee" #define DEFAULT_DET_IP "129.129.202.45" #define DEFAULT_DET_MAC2 "00:aa:bb:cc:dd:ff" #define DEFAULT_DET_IP2 "129.129.202.46" /** default maximum string length */ #define MAX_STR_LENGTH 1000 #define MAX_FRAMES_PER_FILE 20000 #define SHORT_MAX_FRAMES_PER_FILE 100000 #define MOENCH_MAX_FRAMES_PER_FILE 100000 #define EIGER_MAX_FRAMES_PER_FILE 10000 #define JFRAU_MAX_FRAMES_PER_FILE 10000 #define CTB_MAX_FRAMES_PER_FILE 20000 #define MYTHEN3_MAX_FRAMES_PER_FILE 10000 #define GOTTHARD2_MAX_FRAMES_PER_FILE 20000 #define DEFAULT_STREAMING_TIMER_IN_MS 200 // typedef char mystring[MAX_STR_LENGTH]; #ifdef __cplusplus class slsDetectorDefs { public: slsDetectorDefs(){}; #endif /** Type of the detector */ enum detectorType { GET_DETECTOR_TYPE = -1, GENERIC, EIGER, GOTTHARD, JUNGFRAU, CHIPTESTBOARD, MOENCH, MYTHEN3, GOTTHARD2, }; /** return values */ enum { OK, /**< function succeeded */ FAIL, /**< function failed */ FORCE_UPDATE }; /** indexes for the acquisition timers */ enum timerIndex { FRAME_NUMBER, /**< number of real time frames: total number of acquisitions is number or frames*number of triggers */ ACQUISITION_TIME, /**< exposure time */ FRAME_PERIOD, /**< period between exposures */ DELAY_AFTER_TRIGGER, /**< delay between trigger and start of exposure or readout (in triggered mode) */ TRIGGER_NUMBER, /**< number of triggers: total number of acquisitions is number or frames*number of triggers (* number of storage cells [jungfrau]) */ ACTUAL_TIME, /**< Actual time of the detector's internal timer */ MEASUREMENT_TIME, /**< Time of the measurement from the detector (fifo) */ PROGRESS, /**< fraction of measurement elapsed - only get! */ FRAMES_FROM_START, FRAMES_FROM_START_PG, ANALOG_SAMPLES, DIGITAL_SAMPLES, SUBFRAME_ACQUISITION_TIME, /**< subframe exposure time */ STORAGE_CELL_NUMBER, /** sls_bitset; typedef struct { sls_detector_header detHeader; /**< is the detector header */ sls_bitset packetsMask; /**< is the packets caught bit mask */ } sls_receiver_header; typedef uint8_t bitset_storage[MAX_NUM_PACKETS / 8]; #endif /** * frameDiscardPolicy */ enum frameDiscardPolicy { GET_FRAME_DISCARD_POLICY = -1, /**< to get the missing packet mode */ NO_DISCARD, /**< pad incomplete packets with -1, default mode */ DISCARD_EMPTY_FRAMES, /**< discard incomplete frames, fastest mode, save space, not suitable for multiple modules */ DISCARD_PARTIAL_FRAMES, /**< ignore missing packets, must check with packetsMask for data integrity, fast mode and suitable for multiple modules */ NUM_DISCARD_POLICIES }; /** format */ enum fileFormat { GET_FILE_FORMAT = -1, /**< the receiver will return its file format */ BINARY, /**< binary format */ HDF5, /**< hdf5 format */ NUM_FILE_FORMATS }; /** @short structure for a region of interest xmin,xmax,ymin,ymax define the limits of the region */ #ifdef __cplusplus struct ROI { int xmin{-1}; /**< is the roi xmin (in channel number) */ int xmax{-1}; /**< is the roi xmax (in channel number)*/ }; #else typedef struct { int xmin; /**< is the roi xmin (in channel number) */ int xmax; /**< is the roi xmax (in channel number)*/ } ROI; #endif /** network parameters */ enum networkParameter { DETECTOR_MAC, /**< detector MAC */ DETECTOR_IP, /**< detector IP */ RECEIVER_HOSTNAME, /**< receiver IP/hostname */ RECEIVER_UDP_IP, /**< receiever UDP IP */ RECEIVER_UDP_PORT, /**< receiever UDP Port */ RECEIVER_UDP_MAC, /**< receiever UDP MAC */ RECEIVER_UDP_PORT2, /**< receiever UDP Port of second half module for eiger */ DETECTOR_TXN_DELAY_LEFT, /**< transmission delay on the (left) port for next frame */ DETECTOR_TXN_DELAY_RIGHT, /**< transmission delay on the right port for next frame */ DETECTOR_TXN_DELAY_FRAME, /**< transmission delay of a whole frame for all the ports */ FLOW_CONTROL_10G, /**< flow control for 10GbE */ FLOW_CONTROL_WR_PTR, /**< memory write pointer for flow control */ FLOW_CONTROL_RD_PTR, /**< memory read pointer for flow control */ RECEIVER_STREAMING_PORT, /**< receiever streaming TCP(ZMQ) port */ CLIENT_STREAMING_PORT, /**< client streaming TCP(ZMQ) port */ RECEIVER_STREAMING_SRC_IP, /**< receiever streaming TCP(ZMQ) ip */ CLIENT_STREAMING_SRC_IP, /**< client streaming TCP(ZMQ) ip */ ADDITIONAL_JSON_HEADER, /**< additional json header (ZMQ) */ RECEIVER_UDP_SCKT_BUF_SIZE, /**< UDP socket buffer size */ RECEIVER_REAL_UDP_SCKT_BUF_SIZE /**< real UDP socket buffer size */ }; /** type of action performed (for text client) */ enum { GET_ACTION, PUT_ACTION, READOUT_ACTION, HELP_ACTION }; /** flags to get (or set) the size of the detector */ enum numberOf { MAXMODX, /** //hmm... but currently no way around namespace sls{ using Positions = const std::vector &; using defs = slsDetectorDefs; } #endif