3.3 Status Information
3.3.1 Functions for Information Retrieval
The driver provides functions to retrieve detailed information on the type of board, its configu-
ration, settings and state. The information is split according to its scope and the computational
requirements to query the information from the board.
int
xtdc4 get fast info(
xtdc4 device
*device
,
xtdc4 fast info
*info)
Returns fast dynamic information.
This call gets a structure that contains dynamic information that can be obtained within a few
microseconds.
int
xtdc4 get param info(
xtdc4 device
*device
,
xtdc4 param info
*info)
Returns configuration changes.
Gets a structure that contains information that changes indirectly due to configuration changes.
int
xtdc4 get slow info(
xtdc4 device
*device
,
xtdc4 slow info
*info)
Returns slow dynamic information.
The data reported in this structure requires milliseconds to be obtained. The application should
only call it in situation where the program flow can cope with an interruption of that magnitude.
int
xtdc4 get static info(
xtdc4 device
*device
,
xtdc4 static info
*info)
Contains static information.
Gets a structure that contains information about the board that does not change during run
time.
3.3.2 Structure xtdc4 static info
This structure contains information about the board that does not change during run time. It
is provided by the function
xtdc4 get static info
.
int
size
The number of bytes occupied by the structure.
int
version
The version number.
int
board id
ID of the board.
This value is passed to the constructor. It is reflected in the output data.
int
driver revision
Encoded version number.
The lower three bytes contain a triple level hierarchy of version numbers, e.g. 0x010103 encodes
version 1.1.3.
A change in the first digit generally requires a recompilation of user applications. Change in the
second digit denote significant improvements or changes that don’t break compatibility and the
third digit changes with minor bug fixes and similar updates.
int
firmware revision
Revision number of the FPGA configuration.
int
board revision
cronologic GmbH & Co. KG
11
xTDC4 User Guide
Summary of Contents for xTDC4
Page 2: ......
Page 3: ......
Page 7: ......
Page 12: ...Figure 2 6 The xTDC4 Carry Chain TDC calibration tool cronologic GmbH Co KG 7 xTDC4 User Guide...
Page 13: ...cronologic GmbH Co KG 8 xTDC4 User Guide...