beautypg.com

5 status functions, 1 s826_versionread, 2 s826_timestampread – Sensoray 826 User Manual

Page 12: Status functions, S826_versionread, S826_timestampread

background image

Return Values

The return value is always zero.

Remarks

This function should be called when a process (e.g., an application program) has finished interacting with the board's
I/O interfaces, to free system resources that are no longer needed. Any API functions that are blocking will return
immediately, with return value S826_ERR_SYSCLOSED. The board's circuitry is not reset by this function; all
registers and I/O states are preserved.

3.5 Status Functions

3.5.1 S826_VersionRead

The S826_VersionRead function returns API, driver, and board version information.

int S826_VersionRead(
uint board, // board identifier
uint *api, // API version
uint *driver, // driver version
uint *bdrev, // circuit board version
uint *fpgarev // FPGA version
);

Parameters

board

826 board number. This must match the settings of the board's dip switches as described in section 2.2.

api

Pointer to a buffer that will receive the API version info. The hexadecimal value is formatted as 0xXXYYZZZZ,
where XX = major version, YY = minor version, and ZZZZ = build.

driver

Pointer to a buffer that will receive the driver version info. The hexadecimal info is formatted as 0xXXYYZZZZ,
where XX = major version, YY = minor version, and ZZZZ = build.

boardrev

Pointer to a buffer that will receive the version number of the 826's circuit board.

fpgarev

Pointer to a buffer that will receive the board's FPGA version info. The hexadecimal info is formatted as
0xXXYYZZZZ, where XX = major version, YY = minor version, and ZZZZ = build.

Return Values

If the function succeeds, the return value is zero.

If the function fails, the return value is an error code.

3.5.2 S826_TimestampRead

The S826_TimestampRead function returns the current value of the timestamp generator.

int S826_TimestampRead(
uint board, // board identifier
uint *timestamp // current timestamp
);

826 Instruction Manual

7

Programming