3.1 Constants¶

3.1.1 General¶

NDIGO6G12_API_VERSION¶: The current API version.

NDIGO6G12_TRIGGER_COUNT¶: The number of ADC and TDC triggers, including AUTO and ONE.

NDIGO6G12_ADC_CHANNEL_COUNT¶: The number of analog input channels.

NDIGO6G12_GATE_COUNT¶: The number of gating blocks.

NDIGO6G12_TDC_CHANNEL_COUNT¶: The number of high (TDC0-3) and low (TRG, GATE) resolution TDC input channels.

NDIGO6G12_BITSTREAM_DATE_LEN¶: Bitstream date format: YYYY-MM-DD hh:mm:ss

NDIGO6G12_CALIBRATION_DATE_LEN¶: Calibration date format: YYYY-MM-DD hh:mm

NDIGO6G12_FLASH_SIG_LEN¶: Length of Ndigo6G-12 flash signature

NDIGO6G12_FIFO_DEPTH¶

ADC sample FIFO depth.

It is the maximum recording length in multiples of 5 ns.

NDIGO6G12_MAX_PRECURSOR¶: Maximum for ndigo6g12_trigger_block::precursor.

NDIGO6G12_MAX_MULTISHOT¶: Maximum for ndigo6g12_trigger_block::multi_shot_count.

3.1.2 Trigger and Gating Block Sources¶

group sourcedefs

Bitmasks for trigger sources.

Used for ndigo6g12_trigger_block::sources, ndigo6g12_gating_block::sources, ndigo6g12_tdc_gating_block::sources, and ndigo6g12_tdc_tiger_block::sources.

Defines

NDIGO6G12_TRIGGER_SOURCE_NONE¶: All trigger sources disabled.

NDIGO6G12_TRIGGER_SOURCE_A0¶

NDIGO6G12_TRIGGER_SOURCE_A1¶

NDIGO6G12_TRIGGER_SOURCE_B0¶

NDIGO6G12_TRIGGER_SOURCE_B1¶

NDIGO6G12_TRIGGER_SOURCE_C0¶

NDIGO6G12_TRIGGER_SOURCE_C1¶

NDIGO6G12_TRIGGER_SOURCE_D0¶

NDIGO6G12_TRIGGER_SOURCE_D1¶

NDIGO6G12_TRIGGER_SOURCE_TDC0¶

NDIGO6G12_TRIGGER_SOURCE_TDC1¶

NDIGO6G12_TRIGGER_SOURCE_TDC2¶

NDIGO6G12_TRIGGER_SOURCE_TDC3¶

NDIGO6G12_TRIGGER_SOURCE_TRG¶

NDIGO6G12_TRIGGER_SOURCE_GATE¶

NDIGO6G12_TRIGGER_SOURCE_AUTO¶

NDIGO6G12_TRIGGER_SOURCE_ONE¶: Trigger signal is active each clock cycle.

NDIGO6G12_TRIGGER_SOURCE_FPGA0¶: Deprecated. Alias for NDIGO6G12_TRIGGER_SOURCE_TRG.

NDIGO6G12_TRIGGER_SOURCE_FPGA1¶: Deprecated. Alias for NDIGO6G12_TRIGGER_SOURCE_GATE.

3.1.3 Function return values¶

group funcreturns

Return codes of various functions.

All ERRORS must be positive integers, because the upper byte is used by crono_tools

Defines

CRONO_OK¶

CRONO_WINDRIVER_NOT_FOUND¶

CRONO_DEVICE_NOT_FOUND¶

CRONO_NOT_INITIALIZED¶

CRONO_WRONG_STATE¶

CRONO_INVALID_DEVICE¶

CRONO_BUFFER_ALLOC_FAILED¶

CRONO_TDC_NO_EDGE_FOUND¶

CRONO_INVALID_BUFFER_PARAMETERS¶

CRONO_INVALID_CONFIG_PARAMETERS¶

CRONO_WINDOW_CALIBRATION_FAILED¶

CRONO_HARDWARE_FAILURE¶

CRONO_INVALID_ADC_MODE¶

CRONO_SYNCHRONIZATION_FAILED¶

CRONO_DEVICE_OPEN_FAILED¶

CRONO_INTERNAL_ERROR¶

CRONO_CALIBRATION_FAILURE¶

CRONO_INVALID_ARGUMENTS¶

CRONO_INSUFFICIENT_DATA¶

3.1.4 Possible device states¶

group devicestates

Defines for ndigo6g12_fast_info::state.

A device must be configured before data-capturing is started.

Defines

NDIGO6G12_DEVICE_STATE_INITIALIZED¶: Device is initialized but not yet configured for data capture.

NDIGO6G12_DEVICE_STATE_CONFIGURED¶: Device is ready for data capture.

NDIGO6G12_DEVICE_STATE_CAPTURING¶: Device has started data capture.

3.1.5 Alerts¶

group alertdefs

Alert bits from the system monitor.

Used for ndigo6g12_fast_info::alerts.

Defines

NDIGO6G12_ALERT_FPGA_TEMPERATURE¶: FPGA temperature alert (> 70°C)

NDIGO6G12_ALERT_VCCINT¶: Internal FPGA voltage out of range (< 0.83 V or > 0.88 V).

NDIGO6G12_ALERT_VCCAUX¶: FPGA auxiliary voltage out of range (< 1.75 V or > 1.89 V).

NDIGO6G12_ALERT_FPGA_TEMPERATURE_CRITICAL¶: FPGA temperature critical (> 80°C)

NDIGO6G12_ALERT_THS_TEMPERATURE_CRITICAL¶: THS temperature critical (> 140°C)

3.1.6 PCIe Information¶

group pciecorrectableerrors

PCIe correctable error flags.

Only relevant when troubleshooting.

Defines

CRONO_PCIE_RX_ERROR¶

CRONO_PCIE_BAD_TLP¶

CRONO_PCIE_BAD_DLLP¶

CRONO_PCIE_REPLAY_NUM_ROLLOVER¶

CRONO_PCIE_REPLAY_TIMER_TIMEOUT¶

CRONO_PCIE_ADVISORY_NON_FATAL¶

CRONO_PCIE_CORRECTED_INTERNAL_ERROR¶

CRONO_PCIE_HEADER_LOG_OVERFLOW¶

group pcieuncorrectableerrors

PCIe uncorrectable error flags.

Only relevant when troubleshooting.

Defines

CRONO_PCIE_UNC_UNDEFINED¶

CRONO_PCIE_UNC_DATA_LINK_PROTOCOL_ERROR¶

CRONO_PCIE_UNC_SURPRISE_DOWN_ERROR¶

CRONO_PCIE_UNC_POISONED_TLP¶

CRONO_PCIE_UNC_FLOW_CONTROL_PROTOCOL_ERROR¶

CRONO_PCIE_UNC_COMPLETION_TIMEOUT¶

CRONO_PCIE_UNC_COMPLETER_ABORT¶

CRONO_PCIE_UNC_UNEXPECTED_COMPLETION¶

CRONO_PCIE_UNC_RECEIVER_OVERFLOW_ERROR¶

CRONO_PCIE_UNC_MALFORMED_TLP¶

CRONO_PCIE_UNC_ECRC_ERROR¶

CRONO_PCIE_UNC_UNSUPPORED_REQUEST_ERROR¶