Modules | Defines

Macros to describe features enabled in current firmware build
[Macros for XSPRESS3]

Modules

 Crosstalk Glitch detector type.
 Running Average processing options.

Defines

#define XSP3_FEATURE_GET_TEST_DATA_SOURCE(x)   (((x)>>0)&0xF)
#define XSP3_FEATURE_GET_REAL_DATA_SOURCE(x)   (((x)>>4)&0xF)
#define XSP3_FEATURE_GET_DATA_MUX(x)   (((x)>>8)&0xF)
#define XSP3_FEATURE_GET_INL_CORR(x)   (((x)>>12)&0xF)
#define XSP3_FEATURE_GET_RESET_DETECTOR(x)   (((x)>>16)&0xF)
#define XSP3_FEATURE_GET_RESET_CORR(x)   (((x)>>20)&0xF)
#define XSP3_FEATURE_GET_GLITCH_DETECT(x)   (((x)>>24)&0xF)
#define XSP3_FEATURE_GET_GLITCH_PAD(x)   (((x)>>28)&0xF)
#define XSP3_FEATURE_GET_TRIGGER_B(x)   (((x)>>0)&0xF)
#define XSP3_FEATURE_GET_TRIGGER_C(x)   (((x)>>4)&0xF)
#define XSP3_FEATURE_GET_TRIGGER_EXTRA(x)   (((x)>>8)&0xF)
#define XSP3_FEATURE_GET_CALIBRATOR(x)   (((x)>>12)&0xF)
#define XSP3_FEATURE_GET_NEIGHBOUR_EVENTS(x)   (((x)>>16)&0xF)
#define XSP3_FEATURE_GET_SERVO_BASE(x)   (((x)>>20)&0xF)
#define XSP3_FEATURE_GET_SERVO_DETAIL(x)   (((x)>>24)&0xF)
#define XSP3_FEATURE_GET_RUN_AVE(x)   (((x)>>28)&0xF)
#define XSP3_FEATURE_GET_LEAD_TAIL_CORR(x)   (((x)>>0)&0xF)
#define XSP3_FEATURE_GET_OUTPUT_FORMAT(x)   (((x)>>4)&0xF)
#define XSP3_FEATURE_GET_FORMAT_DETAILS_A(x)   (((x)>>8)&0xF)
#define XSP3_FEATURE_GET_FORMAT_DETAILS_B(x)   (((x)>>12)&0xF)
#define XSP3_FEATURE_GET_GLOBAL_RESET(x)   (((x)>>16)&0xF)
#define XSP3_FEATURE_GET_TIMING_SOURCE(x)   (((x)>>20)&0xF)
#define XSP3_FEATURE_GET_TIMING_GENERATOR(x)   (((x)>>24)&0xF)
#define XSP3_FEATURE_GET_SCOPE(x)   (((x)>>28)&0xF)
#define XSP3_FEATURE_GET_TEST_SRC_A(x)   (((x)>>0)&3)
 Test source A from lower 2 bits.
#define XSP3_FEATURE_GET_TEST_SRC_B(x)   (((x)>>2)&3)
 Test source A from upper 2 bits.
#define XSP3_FEATURE_TEST_SRC_A_NONE   0
 No Playback.
#define XSP3_FEATURE_TEST_SRC_A_PB2   1
 Output is list of complete 32 address offsets for histogramming.
#define XSP3_FEATURE_TEST_SRC_B_NONE   0
 No test pattern generator (current builds).
#define XSP3_FEATURE_TEST_SRC_B_TPGEN   1
 BRAM based TP generator.
#define XSP3_FEATURE_RESET_CORR_FIXED1024   0
 Only build is fixed 1024 point table.
#define XSP3_FEATURE_SERVO_BASE_NONE   0
#define XSP3_FEATURE_SERVO_BASE_PWL1   1
 Single table (512 points) PWL servo.
#define XSP3_FEATURE_SERVO_BASE_PWL16   2
 16 table or 1 x 2048 points PWL servo.
#define XSP3_FEATURE_SERVO_BASE_DUAL   3
 Combined linear (gross) and PWL (single table) servo.
#define XSP3_FEATURE_GET_FORMAT_A_NBITS(x)   (((x)>>0)&3)
 Codes Nbits energy 12, 13,14Test source A from lower 2 bits.
#define XSP3_FEATURE_GET_FORMAT_A_AUX1(x)   (((x)>>2)&3)
 Codes Aux1 functionality.
#define XSP3_FEATURE_AUX1_FUNC_NONE   0
 None or Just good mode.
#define XSP3_FEATURE_AUX1_FUNC_DEBUG   1
 Debug modes.
#define XSP3_FEATURE_AUX1_FUNC_THRES   2
 Thresholded Good/bad and Debug.
#define XSP3_FEATURE_AUX1_FUNC_FULL   3
 Full functionality.
#define XSP3_FEATURE_OUTPUT_FORMAT_ADDR32   0
 Output is list of complete 32 address offsets for histogramming.
#define XSP3_FEATURE_OUTPUT_FORMAT_HEIGHTS64   1
 Output is list of 64 bit words including processed event height and all auxiliary info.
#define XSP3_FEATURE_OUTPUT_FORMAT_RAW_AVERAGES   2
 Output is Raw running avreages, needing lead and tail correction and then top-bottom subtraction.
#define XSP3_FEATURE_OUTPUT_FORMAT_DIFFERENCES   8
 Output is ADC input data as a list of differences.
#define XSP3_FEATURE_FORMAT_B_HGT64_ACK_EOF   4
 If XSP3_FEATURE_OUTPUT_FORMAT_HEIGHTS64 this bit implies there is an Acknowledge retry on the eond of frame markers.
#define XSP3_FEATURE_FORMAT_B_HGT64_ACK_TIME   1
 If XSP3_FEATURE_OUTPUT_FORMAT_HEIGHTS64 this bit implies that the ackl and any frame data sends to previous frames total time.



#define XSP3_FEATURE_TIMING_GEN_NONE   0
 XSP3_FEATURS_TIMING_GEN Macros describing the internal timing generator
#define XSP3_FEATURE_TIMING_GEN_MINIMAL_ITFG   1
 Timing Generator is minimal Internal TFG generating nframe all of same length, burst, started or all triggered.



#define XSP3_FEATURE_SCOPE_BIT15_GR_ONLY   0
 XSP3_FEATURS_SCOPE Macros describing the scope mode features
#define XSP3_FEATURE_SCOPE_BIT15_ALT_ENB   1
 Bit 15 of scope mode is uses alternate bits 3..0 to allow HistEnable to be seen.

Define Documentation

#define XSP3_FEATURE_AUX1_FUNC_DEBUG   1

Debug modes.

#define XSP3_FEATURE_AUX1_FUNC_FULL   3

Full functionality.

#define XSP3_FEATURE_AUX1_FUNC_NONE   0

None or Just good mode.

#define XSP3_FEATURE_AUX1_FUNC_THRES   2

Thresholded Good/bad and Debug.

#define XSP3_FEATURE_FORMAT_B_HGT64_ACK_EOF   4

If XSP3_FEATURE_OUTPUT_FORMAT_HEIGHTS64 this bit implies there is an Acknowledge retry on the eond of frame markers.

#define XSP3_FEATURE_FORMAT_B_HGT64_ACK_TIME   1

If XSP3_FEATURE_OUTPUT_FORMAT_HEIGHTS64 this bit implies that the ackl and any frame data sends to previous frames total time.

#define XSP3_FEATURE_GET_CALIBRATOR (   x  )     (((x)>>12)&0xF)
#define XSP3_FEATURE_GET_DATA_MUX (   x  )     (((x)>>8)&0xF)
#define XSP3_FEATURE_GET_FORMAT_A_AUX1 (   x  )     (((x)>>2)&3)

Codes Aux1 functionality.

#define XSP3_FEATURE_GET_FORMAT_A_NBITS (   x  )     (((x)>>0)&3)

Codes Nbits energy 12, 13,14Test source A from lower 2 bits.

#define XSP3_FEATURE_GET_FORMAT_DETAILS_A (   x  )     (((x)>>8)&0xF)
#define XSP3_FEATURE_GET_FORMAT_DETAILS_B (   x  )     (((x)>>12)&0xF)
#define XSP3_FEATURE_GET_GLITCH_DETECT (   x  )     (((x)>>24)&0xF)
#define XSP3_FEATURE_GET_GLITCH_PAD (   x  )     (((x)>>28)&0xF)
#define XSP3_FEATURE_GET_GLOBAL_RESET (   x  )     (((x)>>16)&0xF)
#define XSP3_FEATURE_GET_INL_CORR (   x  )     (((x)>>12)&0xF)
#define XSP3_FEATURE_GET_LEAD_TAIL_CORR (   x  )     (((x)>>0)&0xF)
#define XSP3_FEATURE_GET_NEIGHBOUR_EVENTS (   x  )     (((x)>>16)&0xF)
#define XSP3_FEATURE_GET_OUTPUT_FORMAT (   x  )     (((x)>>4)&0xF)
#define XSP3_FEATURE_GET_REAL_DATA_SOURCE (   x  )     (((x)>>4)&0xF)
#define XSP3_FEATURE_GET_RESET_CORR (   x  )     (((x)>>20)&0xF)
#define XSP3_FEATURE_GET_RESET_DETECTOR (   x  )     (((x)>>16)&0xF)
#define XSP3_FEATURE_GET_RUN_AVE (   x  )     (((x)>>28)&0xF)
#define XSP3_FEATURE_GET_SCOPE (   x  )     (((x)>>28)&0xF)
#define XSP3_FEATURE_GET_SERVO_BASE (   x  )     (((x)>>20)&0xF)
#define XSP3_FEATURE_GET_SERVO_DETAIL (   x  )     (((x)>>24)&0xF)
#define XSP3_FEATURE_GET_TEST_DATA_SOURCE (   x  )     (((x)>>0)&0xF)
#define XSP3_FEATURE_GET_TEST_SRC_A (   x  )     (((x)>>0)&3)

Test source A from lower 2 bits.

#define XSP3_FEATURE_GET_TEST_SRC_B (   x  )     (((x)>>2)&3)

Test source A from upper 2 bits.

#define XSP3_FEATURE_GET_TIMING_GENERATOR (   x  )     (((x)>>24)&0xF)
#define XSP3_FEATURE_GET_TIMING_SOURCE (   x  )     (((x)>>20)&0xF)
#define XSP3_FEATURE_GET_TRIGGER_B (   x  )     (((x)>>0)&0xF)
#define XSP3_FEATURE_GET_TRIGGER_C (   x  )     (((x)>>4)&0xF)
#define XSP3_FEATURE_GET_TRIGGER_EXTRA (   x  )     (((x)>>8)&0xF)
#define XSP3_FEATURE_OUTPUT_FORMAT_ADDR32   0

Output is list of complete 32 address offsets for histogramming.

#define XSP3_FEATURE_OUTPUT_FORMAT_DIFFERENCES   8

Output is ADC input data as a list of differences.

#define XSP3_FEATURE_OUTPUT_FORMAT_HEIGHTS64   1

Output is list of 64 bit words including processed event height and all auxiliary info.

#define XSP3_FEATURE_OUTPUT_FORMAT_RAW_AVERAGES   2

Output is Raw running avreages, needing lead and tail correction and then top-bottom subtraction.

#define XSP3_FEATURE_RESET_CORR_FIXED1024   0

Only build is fixed 1024 point table.

#define XSP3_FEATURE_SCOPE_BIT15_ALT_ENB   1

Bit 15 of scope mode is uses alternate bits 3..0 to allow HistEnable to be seen.

#define XSP3_FEATURE_SCOPE_BIT15_GR_ONLY   0

XSP3_FEATURS_SCOPE Macros describing the scope mode features

Bit 15 of scope mode is alway Global Reset active (origianl builds)

#define XSP3_FEATURE_SERVO_BASE_DUAL   3

Combined linear (gross) and PWL (single table) servo.

#define XSP3_FEATURE_SERVO_BASE_NONE   0

No servo.

#define XSP3_FEATURE_SERVO_BASE_PWL1   1

Single table (512 points) PWL servo.

#define XSP3_FEATURE_SERVO_BASE_PWL16   2

16 table or 1 x 2048 points PWL servo.

#define XSP3_FEATURE_TEST_SRC_A_NONE   0

No Playback.

#define XSP3_FEATURE_TEST_SRC_A_PB2   1

Output is list of complete 32 address offsets for histogramming.

#define XSP3_FEATURE_TEST_SRC_B_NONE   0

No test pattern generator (current builds).

#define XSP3_FEATURE_TEST_SRC_B_TPGEN   1

BRAM based TP generator.

#define XSP3_FEATURE_TIMING_GEN_MINIMAL_ITFG   1

Timing Generator is minimal Internal TFG generating nframe all of same length, burst, started or all triggered.

#define XSP3_FEATURE_TIMING_GEN_NONE   0

XSP3_FEATURS_TIMING_GEN Macros describing the internal timing generator

Timing Generator is not present