Custom GenTL (C API)

Euresys Custom GenTL low-level C API. More...

Modules
	Euresys Events
	Definition of Euresys Coaxlink-specific Events.

Enumerations
enum	DEVICE_ACCESS_FLAGS_CUSTOM_LIST { DEVICE_ACCESS_CUSTOM_READONLY_DEVICE_READONLY_STREAM = DEVICE_ACCESS_CUSTOM_ID + 1 , DEVICE_ACCESS_CUSTOM_SERIAL_COMMUNICATION = DEVICE_ACCESS_CUSTOM_ID + 2 }
	This enumeration defines Euresys custom flags of how a device is to be opened with the GenICam::TL::Client::IFOpenDevice function. More...
enum	ACQ_START_FLAGS_CUSTOM_LIST { ACQ_START_FLAGS_CUSTOM_DO_NOT_ACTIVATE_SEQUENCER = ACQ_START_FLAGS_CUSTOM_ID + 1 }
	This enumeration defines Euresys custom flags for how the acquisition engine must be started. More...
enum	GC_CUSTOM_ERROR_LIST {   GC_ERR_CUSTOM_MULTIPLE_HANDLES = GC_ERR_CUSTOM_ID - 1 , GC_ERR_CUSTOM_DANGLING_HANDLES = GC_ERR_CUSTOM_ID - 2 , GC_ERR_CUSTOM_LOST_HANDLE = GC_ERR_CUSTOM_ID - 3 , GC_ERR_CUSTOM_LOCK_ERROR = GC_ERR_CUSTOM_ID - 4 ,   GC_ERR_CUSTOM_SILENT_ERROR = GC_ERR_CUSTOM_ID - 5 , GC_ERR_CUSTOM_LIBPATH_ERROR = GC_ERR_CUSTOM_ID - 6 , GC_ERR_CUSTOM_DRIVER_NOT_AVAILABLE = GC_ERR_CUSTOM_ID - 7 , GC_ERR_CUSTOM_DRIVER_IO_ERROR = GC_ERR_CUSTOM_ID - 8 ,   GC_ERR_CUSTOM_STD_EXCEPTION = GC_ERR_CUSTOM_ID - 12 , GC_ERR_CUSTOM_ALIGNMENT_ERROR = GC_ERR_CUSTOM_ID - 13 , GC_ERR_CUSTOM_WAIT_FAILED = GC_ERR_CUSTOM_ID - 14 , GC_ERR_CUSTOM_WAIT_INTERRUPTED = GC_ERR_CUSTOM_ID - 15 ,   GC_ERR_CUSTOM_CANNOT_CREATE_NOTIFIER = GC_ERR_CUSTOM_ID - 16 , GC_ERR_CUSTOM_NOTIFIER_ERROR = GC_ERR_CUSTOM_ID - 17 , GC_ERR_CUSTOM_LOADING_ERROR = GC_ERR_CUSTOM_ID - 18 , GC_ERR_CUSTOM_SYMBOL_NOT_FOUND = GC_ERR_CUSTOM_ID - 19 ,   GC_ERR_CUSTOM_STRING_TOO_LONG = GC_ERR_CUSTOM_ID - 20 , GC_ERR_CUSTOM_DATATYPE_MISMATCH = GC_ERR_CUSTOM_ID - 21 , GC_ERR_CUSTOM_TOO_MANY_GENAPI_CONTEXTS = GC_ERR_CUSTOM_ID - 22 , GC_ERR_CUSTOM_INCORRECT_OEM_SAFETY_KEY = GC_ERR_CUSTOM_ID - 23 ,   GC_ERR_CUSTOM_OPAQUE_NETWORK = GC_ERR_CUSTOM_ID - 24 , GC_ERR_CUSTOM_GENAPI_FEATURE_NOT_FOUND = GC_ERR_CUSTOM_ID - 25 , GC_ERR_CUSTOM_INVALID_BUFFER_ADDRESS = GC_ERR_CUSTOM_ID - 26 , GC_ERR_CUSTOM_ASSERT_FAILED = GC_ERR_CUSTOM_ID - 27 ,   GC_ERR_CUSTOM_NETWORK_CONFIGURATION_ERROR = GC_ERR_CUSTOM_ID - 28 , GC_ERR_CUSTOM_RDMA_INCOMPATIBLE_PROTOCOL = GC_ERR_CUSTOM_ID - 29 , GC_ERR_CUSTOM_RDMA_INCOMPATIBLE_VERSION = GC_ERR_CUSTOM_ID - 30 , GC_ERR_CUSTOM_RDMA_CONNECTION_INVALID = GC_ERR_CUSTOM_ID - 31 ,   GC_ERR_CUSTOM_RDMA_DEVICE_REMOVED = GC_ERR_CUSTOM_ID - 32 , GC_ERR_CUSTOM_BUFFER_SIZE_TOO_LARGE = GC_ERR_CUSTOM_ID - 33 , GC_ERR_CUSTOM_RDMA_CONNECTION_REFUSED = GC_ERR_CUSTOM_ID - 34 , GC_ERR_CUSTOM_RDMA_CONNECTION_ABORTED = GC_ERR_CUSTOM_ID - 35 ,   GC_ERR_CUSTOM_RDMA_CONNECTION_CANCELED = GC_ERR_CUSTOM_ID - 36 , GC_ERR_CUSTOM_INVALID_CONFIG = GC_ERR_CUSTOM_ID - 37 , GC_ERR_CUSTOM_GENDC_SIZE_TOO_SMALL = GC_ERR_CUSTOM_ID - 38 , GC_ERR_CUSTOM_GENDC_INVALID_OFFSET = GC_ERR_CUSTOM_ID - 39 ,   GC_ERR_CUSTOM_RDMA_COMMUNICATION_ERROR = GC_ERR_CUSTOM_ID - 40 , GC_ERR_CUSTOM_GENAPI_ERROR = GC_ERR_CUSTOM_ID - 100 , GC_ERR_CUSTOM_IMAGE_ERROR = GC_ERR_CUSTOM_ID - 200 , GC_ERR_CUSTOM_LICENSE_MANAGER_ERROR = GC_ERR_CUSTOM_ID - 300 ,   GC_ERR_CUSTOM_NO_LICENSE = GC_ERR_CUSTOM_ID - 301 , GC_ERR_CUSTOM_CL_ERR = GC_ERR_CUSTOM_ID - 400 , GC_ERR_CUSTOM_CL_RECEIVER_NOT_READY = GC_ERR_CUSTOM_ID - 401 , GC_ERR_CUSTOM_RECORDER_ERROR = GC_ERR_CUSTOM_ID - 500 ,   GC_ERR_CUSTOM_IOCTL_PCI_WRITE_CONFIG_FAILED = GC_ERR_CUSTOM_IOCTL_BASE - 3 , GC_ERR_CUSTOM_IOCTL_PCI_READ_CONFIG_FAILED = GC_ERR_CUSTOM_IOCTL_BASE - 4 , GC_ERR_CUSTOM_IOCTL_DS_CREATE_NO_DMA_ENGINE = GC_ERR_CUSTOM_IOCTL_BASE - 5 , GC_ERR_CUSTOM_IOCTL_DS_CREATE_NO_IRQ_HANDLER = GC_ERR_CUSTOM_IOCTL_BASE - 6 ,   GC_ERR_CUSTOM_IOCTL_DS_REGISTER_EVENT_FAILED = GC_ERR_CUSTOM_IOCTL_BASE - 7 , GC_ERR_CUSTOM_IOCTL_DS_OPEN_FAILED = GC_ERR_CUSTOM_IOCTL_BASE - 9 , GC_ERR_CUSTOM_IOCTL_DS_START_FAILED = GC_ERR_CUSTOM_IOCTL_BASE - 10 , GC_ERR_CUSTOM_IOCTL_DEV_GET_URL_INFO_FAILED = GC_ERR_CUSTOM_IOCTL_BASE - 13 ,   GC_ERR_CUSTOM_IOCTL_CXP_CONNECTION_WRITE_FAILED = GC_ERR_CUSTOM_IOCTL_BASE - 14 , GC_ERR_CUSTOM_IOCTL_CXP_CONNECTION_READ_FAILED = GC_ERR_CUSTOM_IOCTL_BASE - 15 , GC_ERR_CUSTOM_IOCTL_BUFFER_ANNOUNCE_FAILED = GC_ERR_CUSTOM_IOCTL_BASE - 18 , GC_ERR_CUSTOM_IOCTL_STOP_TIMEOUT = GC_ERR_CUSTOM_IOCTL_BASE - 19 ,   GC_ERR_CUSTOM_IOCTL_I2C_FAILED = GC_ERR_CUSTOM_IOCTL_BASE - 20 , GC_ERR_CUSTOM_IOCTL_BANK_SELECT_INCONSISTENCY = GC_ERR_CUSTOM_IOCTL_BASE - 21 , GC_ERR_CUSTOM_IOCTL_ONBOARD_MEMORY_READ_ERROR = GC_ERR_CUSTOM_IOCTL_BASE - 22 , GC_ERR_CUSTOM_IOCTL_ONBOARD_MEMORY_WRITE_ERROR = GC_ERR_CUSTOM_IOCTL_BASE - 23 ,   GC_ERR_CUSTOM_IOCTL_FFC_WRITE_ERROR = GC_ERR_CUSTOM_IOCTL_BASE - 24 , GC_ERR_CUSTOM_IOCTL_SERIAL_REGISTER_EVENT_FAILED = GC_ERR_CUSTOM_IOCTL_BASE - 25 , GC_ERR_CUSTOM_GENCP_BASE = -327680 }
	This enumeration defines Euresys custom errors (GenTL::GC_ERROR) More...
enum	DEVICE_INFO_CUSTOM_CMD_LIST { DEVICE_INFO_CUSTOM_DEVICE_DESCRIPTION = DEVICE_INFO_CUSTOM_ID + 70 }
	This enumeration defines Euresys custom commands to retrieve information with the GenTL::DevGetInfo function on a device handle. More...
enum	STREAM_INFO_CUSTOM_CMD_LIST { STREAM_INFO_CUSTOM_STREAM_DESCRIPTION = STREAM_INFO_CUSTOM_ID + 110 , STREAM_INFO_CUSTOM_SHOULD_REANNOUNCE_BUFFERS = STREAM_INFO_CUSTOM_ID + 135 , STREAM_INFO_CUSTOM_SHOULD_REALLOC_BUFFERS = STREAM_INFO_CUSTOM_ID + 136 }
	This enumeration defines Euresys custom commands to retrieve information with the GenTL::DSGetInfo function on a data stream handle. More...
enum	BUFFER_INFO_CUSTOM_CMD_LIST {   BUFFER_INFO_CUSTOM_START_OF_SCAN = BUFFER_INFO_CUSTOM_ID + 1 , BUFFER_INFO_CUSTOM_END_OF_SCAN = BUFFER_INFO_CUSTOM_ID + 2 , BUFFER_INFO_CUSTOM_EVENT_TIMESTAMP = BUFFER_INFO_CUSTOM_ID + 5 , BUFFER_INFO_CUSTOM_CXP_STREAMID = BUFFER_INFO_CUSTOM_ID + 6 ,   BUFFER_INFO_CUSTOM_CXP_TAPG = BUFFER_INFO_CUSTOM_ID + 7 , BUFFER_INFO_CUSTOM_CXP_FLAGS = BUFFER_INFO_CUSTOM_ID + 8 , BUFFER_INFO_CUSTOM_LINE_PITCH = BUFFER_INFO_CUSTOM_ID + 10 , BUFFER_INFO_CUSTOM_STREAM_LINE_WIDTH = BUFFER_INFO_CUSTOM_ID + 12 ,   BUFFER_INFO_CUSTOM_STREAM_LINE_PITCH = BUFFER_INFO_CUSTOM_ID + 13 , BUFFER_INFO_CUSTOM_STREAM_STRIPE_HEIGHT = BUFFER_INFO_CUSTOM_ID + 14 , BUFFER_INFO_CUSTOM_STREAM_STRIPE_PITCH = BUFFER_INFO_CUSTOM_ID + 15 , BUFFER_INFO_CUSTOM_STREAM_STRIPE_ARRANGEMENT = BUFFER_INFO_CUSTOM_ID + 16 ,   BUFFER_INFO_CUSTOM_CUSTOM_LOGIC_STATUS = BUFFER_INFO_CUSTOM_ID + 19 , BUFFER_INFO_CUSTOM_STREAM_STRIPE_OFFSET = BUFFER_INFO_CUSTOM_ID + 20 , BUFFER_INFO_CUSTOM_STREAM_BLOCK_HEIGHT = BUFFER_INFO_CUSTOM_ID + 21 , BUFFER_INFO_CUSTOM_LLE_LINES_PER_IMAGE = BUFFER_INFO_CUSTOM_ID + 24 ,   BUFFER_INFO_CUSTOM_ALIGNMENT = BUFFER_INFO_CUSTOM_ID + 26 , BUFFER_INFO_CUSTOM_PART_SIZE = BUFFER_INFO_CUSTOM_ID + 27 , BUFFER_INFO_CUSTOM_NUM_PARTS = BUFFER_INFO_CUSTOM_ID + 28 , BUFFER_INFO_CUSTOM_NUM_DELIVERED_PARTS = BUFFER_INFO_CUSTOM_ID + 29 ,   BUFFER_INFO_CUSTOM_PART_TIMESTAMPS = BUFFER_INFO_CUSTOM_ID + 30 , BUFFER_INFO_CUSTOM_BUFFER_METADATA_0 = BUFFER_INFO_CUSTOM_ID + 39 , BUFFER_INFO_CUSTOM_BUFFER_METADATA_1 = BUFFER_INFO_CUSTOM_ID + 40 , BUFFER_INFO_CUSTOM_BUFFER_METADATA_2 = BUFFER_INFO_CUSTOM_ID + 45 ,   BUFFER_INFO_CUSTOM_BUFFER_METADATA_3 = BUFFER_INFO_CUSTOM_ID + 46 , BUFFER_INFO_CUSTOM_HAS_BUFFER_METADATA = BUFFER_INFO_CUSTOM_ID + 49 , BUFFER_INFO_CUSTOM_HAS_LINE_METADATA = BUFFER_INFO_CUSTOM_ID + 50 , BUFFER_INFO_CUSTOM_LINE_METADATA_BASE = BUFFER_INFO_CUSTOM_ID + 51 ,   BUFFER_INFO_CUSTOM_METADATA_CONTENT_0 = BUFFER_INFO_CUSTOM_ID + 52 , BUFFER_INFO_CUSTOM_METADATA_CONTENT_1 = BUFFER_INFO_CUSTOM_ID + 53 , BUFFER_INFO_CUSTOM_METADATA_CONTENT_2 = BUFFER_INFO_CUSTOM_ID + 54 , BUFFER_INFO_CUSTOM_METADATA_CONTENT_3 = BUFFER_INFO_CUSTOM_ID + 55 ,   BUFFER_INFO_CUSTOM_CXP_PIXELF = BUFFER_INFO_CUSTOM_ID + 57 }
	This enumeration defines Euresys custom commands to retrieve information with the GenTL::DSGetBufferInfo function on a buffer handle. More...
enum	PORT_INFO_CUSTOM_CMD_LIST { PORT_INFO_CUSTOM_CONTROL_PROTOCOL = PORT_INFO_CUSTOM_ID + 3 }
	This enumeration defines Euresys custom commands to retrieve information with the GenTL::GCGetPortInfo function on a port handle. More...
enum	MEMORY_TYPE_LIST { MEMORY_TYPE_BUS_ADDRESS = -1 , MEMORY_TYPE_DEFAULT = 0 , MEMORY_TYPE_NVIDIA_RDMA = 1 }
	This enumeration defines Euresys custom type of announced memory. More...
typedef int	MEMORY_TYPE
typedef struct GenTL::EuresysCustomGenTL::S_EURESYS_EVENT_GET_DATA_ENTRY	EURESYS_EVENT_GET_DATA_ENTRY
GC_API	EuresysDSAnnounceBusBuffer (DS_HANDLE hDataStream, uint64_t busAddress, size_t iSize, void *reserved, void *pPrivate, BUFFER_HANDLE *phBuffer)
GC_API	EuresysDSAnnounceDeviceBuffer (DS_HANDLE hDataStream, void *pBuffer, size_t iSize, MEMORY_TYPE memType, void *pPrivate, BUFFER_HANDLE *phBuffer)
GC_API	EuresysEventsGetData (EURESYS_EVENT_GET_DATA_ENTRY *pEntries, size_t iNumEntries, uint64_t *piTimeout)
	Wait for multiple events.

Detailed Description

Euresys Custom GenTL low-level C API.

Typedef Documentation

MEMORY_TYPE

typedef int MEMORY_TYPE

EURESYS_EVENT_GET_DATA_ENTRY

typedef struct GenTL::EuresysCustomGenTL::S_EURESYS_EVENT_GET_DATA_ENTRY EURESYS_EVENT_GET_DATA_ENTRY

Enumeration Type Documentation

DEVICE_ACCESS_FLAGS_CUSTOM_LIST

enum DEVICE_ACCESS_FLAGS_CUSTOM_LIST

This enumeration defines Euresys custom flags of how a device is to be opened with the GenICam::TL::Client::IFOpenDevice function.

Enumerator
DEVICE_ACCESS_CUSTOM_READONLY_DEVICE_READONLY_STREAM	Open both the device and child data stream read only.
DEVICE_ACCESS_CUSTOM_SERIAL_COMMUNICATION	Open the device for serial communication.

ACQ_START_FLAGS_CUSTOM_LIST

enum ACQ_START_FLAGS_CUSTOM_LIST

This enumeration defines Euresys custom flags for how the acquisition engine must be started.

The function used is GenICam::TL::Client::DSStartAcquisition.

Enumerator
ACQ_START_FLAGS_CUSTOM_DO_NOT_ACTIVATE_SEQUENCER	Start the data stream but leave the CIC sequencer idle.

GC_CUSTOM_ERROR_LIST

enum GC_CUSTOM_ERROR_LIST

This enumeration defines Euresys custom errors (GenTL::GC_ERROR)

Enumerator
GC_ERR_CUSTOM_MULTIPLE_HANDLES	Different handles to the same object were found.
GC_ERR_CUSTOM_DANGLING_HANDLES	Handles associated to a closed object were found.
GC_ERR_CUSTOM_LOST_HANDLE	No handle associated to an opened object was found.
GC_ERR_CUSTOM_LOCK_ERROR	A lock issue has been detected.
GC_ERR_CUSTOM_SILENT_ERROR	Some silent errors occurred.
GC_ERR_CUSTOM_LIBPATH_ERROR	Library path cannot be retrieved.
GC_ERR_CUSTOM_DRIVER_NOT_AVAILABLE	Failed to access the driver.
GC_ERR_CUSTOM_DRIVER_IO_ERROR	A driver error has occurred.
GC_ERR_CUSTOM_STD_EXCEPTION	Caught a C++ std::exception.
GC_ERR_CUSTOM_ALIGNMENT_ERROR	An alignment error occurred while accessing a module port.
GC_ERR_CUSTOM_WAIT_FAILED	A wait operation failed unexpectedly.
GC_ERR_CUSTOM_WAIT_INTERRUPTED	A wait operation has been interrupted.
GC_ERR_CUSTOM_CANNOT_CREATE_NOTIFIER	Cannot create notification object.
GC_ERR_CUSTOM_NOTIFIER_ERROR	Cannot access notification object state.
GC_ERR_CUSTOM_LOADING_ERROR	An external module could not be loaded.
GC_ERR_CUSTOM_SYMBOL_NOT_FOUND	A required symbol was not found.
GC_ERR_CUSTOM_STRING_TOO_LONG	A string is too long.
GC_ERR_CUSTOM_DATATYPE_MISMATCH	Data type mismatch.
GC_ERR_CUSTOM_TOO_MANY_GENAPI_CONTEXTS	Too many GenApi contexts.
GC_ERR_CUSTOM_INCORRECT_OEM_SAFETY_KEY	Key doesn't match programmed OEM safety key.
GC_ERR_CUSTOM_OPAQUE_NETWORK	GEV Driver could not communicate with the camera.
GC_ERR_CUSTOM_GENAPI_FEATURE_NOT_FOUND	A GenApi feature could not be found.
GC_ERR_CUSTOM_INVALID_BUFFER_ADDRESS	A buffer address does not match any announced buffer address.
GC_ERR_CUSTOM_ASSERT_FAILED	An internal assertion failed.
GC_ERR_CUSTOM_NETWORK_CONFIGURATION_ERROR	Subnet mismatch, invalid IP address and the like.
GC_ERR_CUSTOM_RDMA_INCOMPATIBLE_PROTOCOL	Unexpected values in connection data.
GC_ERR_CUSTOM_RDMA_INCOMPATIBLE_VERSION	Remote device requires a protocol version that is not supported.
GC_ERR_CUSTOM_RDMA_CONNECTION_INVALID	Connection doesn't have the expected state at the time of the call.
GC_ERR_CUSTOM_RDMA_DEVICE_REMOVED	The underlying NetworkDirect adapter was removed from the system.
GC_ERR_CUSTOM_BUFFER_SIZE_TOO_LARGE	The specified buffer length exceeds the capabilities of the underlying NetworkDirect hardware.
GC_ERR_CUSTOM_RDMA_CONNECTION_REFUSED	The remote system refused the connection request.
GC_ERR_CUSTOM_RDMA_CONNECTION_ABORTED	The remote system aborted the connection.
GC_ERR_CUSTOM_RDMA_CONNECTION_CANCELED	The local system terminated the connection.
GC_ERR_CUSTOM_INVALID_CONFIG	An error occured during parsing of a configuration file.
GC_ERR_CUSTOM_GENDC_SIZE_TOO_SMALL	GenDC data structure size is smaller than base header size.
GC_ERR_CUSTOM_GENDC_INVALID_OFFSET	Offset entry in GenDC data structure goes out of containing buffer.
GC_ERR_CUSTOM_RDMA_COMMUNICATION_ERROR	System error occured during RDMA transfer request.
GC_ERR_CUSTOM_GENAPI_ERROR	A GenApi error has occurred.
GC_ERR_CUSTOM_IMAGE_ERROR	An error occurred while processing an image.
GC_ERR_CUSTOM_LICENSE_MANAGER_ERROR	An error occurred in the License Manager.
GC_ERR_CUSTOM_NO_LICENSE	No license was found.
GC_ERR_CUSTOM_CL_ERR	A CL error occurred.
GC_ERR_CUSTOM_CL_RECEIVER_NOT_READY	CL receiver could not get ready to start acquisition.
GC_ERR_CUSTOM_RECORDER_ERROR	An eGrabber Recorder error occurred.
GC_ERR_CUSTOM_IOCTL_PCI_WRITE_CONFIG_FAILED	Driver could not write to PCI configuration space of device.
GC_ERR_CUSTOM_IOCTL_PCI_READ_CONFIG_FAILED	Driver could not read from PCI configuration space of device.
GC_ERR_CUSTOM_IOCTL_DS_CREATE_NO_DMA_ENGINE	Driver could not find a DMA engine.
GC_ERR_CUSTOM_IOCTL_DS_CREATE_NO_IRQ_HANDLER	Driver has no IRQ handler.
GC_ERR_CUSTOM_IOCTL_DS_REGISTER_EVENT_FAILED	Driver could not register notification object while creating the data stream.
GC_ERR_CUSTOM_IOCTL_DS_OPEN_FAILED	Driver could not open DataStream module.
GC_ERR_CUSTOM_IOCTL_DS_START_FAILED	Driver could not start the acquisition engine.
GC_ERR_CUSTOM_IOCTL_DEV_GET_URL_INFO_FAILED	Driver error while getting remote device URL information.
GC_ERR_CUSTOM_IOCTL_CXP_CONNECTION_WRITE_FAILED	Driver could not not write to remote device CoaXPress register.
GC_ERR_CUSTOM_IOCTL_CXP_CONNECTION_READ_FAILED	Driver could not not read remote device CoaXPress register.
GC_ERR_CUSTOM_IOCTL_BUFFER_ANNOUNCE_FAILED	Driver was not able to announce a buffer.
GC_ERR_CUSTOM_IOCTL_STOP_TIMEOUT	Driver could not stop the acquisition engine in a timely fashion.
GC_ERR_CUSTOM_IOCTL_I2C_FAILED	Driver I2C error.
GC_ERR_CUSTOM_IOCTL_BANK_SELECT_INCONSISTENCY	Driver detected a flash bank select inconsistency.
GC_ERR_CUSTOM_IOCTL_ONBOARD_MEMORY_READ_ERROR	Driver could not read from onboard memory.
GC_ERR_CUSTOM_IOCTL_ONBOARD_MEMORY_WRITE_ERROR	Driver could not write to onboard memory.
GC_ERR_CUSTOM_IOCTL_FFC_WRITE_ERROR	Driver could not write Flat Field Correction coefficient data.
GC_ERR_CUSTOM_IOCTL_SERIAL_REGISTER_EVENT_FAILED	Driver could not register serial notification object.
GC_ERR_CUSTOM_GENCP_BASE

DEVICE_INFO_CUSTOM_CMD_LIST

enum DEVICE_INFO_CUSTOM_CMD_LIST

This enumeration defines Euresys custom commands to retrieve information with the GenTL::DevGetInfo function on a device handle.

Enumerator
DEVICE_INFO_CUSTOM_DEVICE_DESCRIPTION	STRING Description of the device.

STREAM_INFO_CUSTOM_CMD_LIST

enum STREAM_INFO_CUSTOM_CMD_LIST

This enumeration defines Euresys custom commands to retrieve information with the GenTL::DSGetInfo function on a data stream handle.

Enumerator
STREAM_INFO_CUSTOM_STREAM_DESCRIPTION	STRING Description of the stream.
STREAM_INFO_CUSTOM_SHOULD_REANNOUNCE_BUFFERS	BOOL8 Flag to indicate that internal resources (like the DMA) need to be reconfigured and thus buffers need to be revoked and announced again.
STREAM_INFO_CUSTOM_SHOULD_REALLOC_BUFFERS	BOOL8 Flag to indicate that buffers need to be revoked and reallocated again because the payload size or alignment constraints have changed.

BUFFER_INFO_CUSTOM_CMD_LIST

enum BUFFER_INFO_CUSTOM_CMD_LIST

This enumeration defines Euresys custom commands to retrieve information with the GenTL::DSGetBufferInfo function on a buffer handle.

Enumerator
BUFFER_INFO_CUSTOM_START_OF_SCAN	BOOL8 Flag to indicate that the buffer is the first of a scan.
BUFFER_INFO_CUSTOM_END_OF_SCAN	BOOL8 Flag to indicate that the buffer is the last of a scan.
BUFFER_INFO_CUSTOM_EVENT_TIMESTAMP	UINT64 Timestamp of the new buffer event.
BUFFER_INFO_CUSTOM_CXP_STREAMID	UINT16 Stream ID (word 3 in the CoaXPress rectangular image header)
BUFFER_INFO_CUSTOM_CXP_TAPG	UINT16 Tap geometry (words 23-24 in the CoaXPress rectangular image header)
BUFFER_INFO_CUSTOM_CXP_FLAGS	UINT16 Image flags (word 25 in the CoaXPress rectangular image header)
BUFFER_INFO_CUSTOM_LINE_PITCH	SIZET Line pitch (or 1 for buffers containing JPEG data)
BUFFER_INFO_CUSTOM_STREAM_LINE_WIDTH	SIZET Deprecated (will be removed in a future release)
BUFFER_INFO_CUSTOM_STREAM_LINE_PITCH	SIZET Deprecated (will be removed in a future release)
BUFFER_INFO_CUSTOM_STREAM_STRIPE_HEIGHT	SIZET Deprecated (will be removed in a future release)
BUFFER_INFO_CUSTOM_STREAM_STRIPE_PITCH	SIZET Deprecated (will be removed in a future release)
BUFFER_INFO_CUSTOM_STREAM_STRIPE_ARRANGEMENT	UINT64 Value of data stream StripeArrangement when the buffer was announced.
BUFFER_INFO_CUSTOM_CUSTOM_LOGIC_STATUS	UINT32 CustomLogic Status associated to the buffer.
BUFFER_INFO_CUSTOM_STREAM_STRIPE_OFFSET	SIZET Deprecated (will be removed in a future release)
BUFFER_INFO_CUSTOM_STREAM_BLOCK_HEIGHT	SIZET Deprecated (will be removed in a future release)
BUFFER_INFO_CUSTOM_LLE_LINES_PER_IMAGE	SIZET Number of LLE extracted lines per acquired image.
BUFFER_INFO_CUSTOM_ALIGNMENT	SIZET Alignment of buffer allocated by DSAllocAndAnnounceBuffer.
BUFFER_INFO_CUSTOM_PART_SIZE	SIZET Size of each buffer part.
BUFFER_INFO_CUSTOM_NUM_PARTS	SIZET Maximum number of parts in the buffer (value of data stream BufferPartCount when the buffer was announced)
BUFFER_INFO_CUSTOM_NUM_DELIVERED_PARTS	SIZET Number of parts available in the buffer.
BUFFER_INFO_CUSTOM_PART_TIMESTAMPS	BUFFER Array of 64-bit unsigned integers containing the timestamps of each buffer part.
BUFFER_INFO_CUSTOM_BUFFER_METADATA_0	UINT32 32-bit inserted buffer metadata at offset 0.
BUFFER_INFO_CUSTOM_BUFFER_METADATA_1	UINT32 32-bit inserted buffer metadata at offset 1.
BUFFER_INFO_CUSTOM_BUFFER_METADATA_2	UINT32 32-bit inserted buffer metadata at offset 2.
BUFFER_INFO_CUSTOM_BUFFER_METADATA_3	UINT32 32-bit inserted buffer metadata at offset 3.
BUFFER_INFO_CUSTOM_HAS_BUFFER_METADATA	BOOL8 Flag to indicate that the buffer has inserted buffer metadata.
BUFFER_INFO_CUSTOM_HAS_LINE_METADATA	BOOL8 Flag to indicate that the buffer has inserted line metadata.
BUFFER_INFO_CUSTOM_LINE_METADATA_BASE	PTR Base address of the inserted line metadata.
BUFFER_INFO_CUSTOM_METADATA_CONTENT_0	UINT16 Content ID of the 32-bit inserted metadata at offset 0.
BUFFER_INFO_CUSTOM_METADATA_CONTENT_1	UINT16 Content ID of the 32-bit inserted metadata at offset 1.
BUFFER_INFO_CUSTOM_METADATA_CONTENT_2	UINT16 Content ID of the 32-bit inserted metadata at offset 2.
BUFFER_INFO_CUSTOM_METADATA_CONTENT_3	UINT16 Content ID of the 32-bit inserted metadata at offset 3.
BUFFER_INFO_CUSTOM_CXP_PIXELF	UINT32 PixelF (words 21-22 in the CoaXPress rectangular image header)

PORT_INFO_CUSTOM_CMD_LIST

enum PORT_INFO_CUSTOM_CMD_LIST

This enumeration defines Euresys custom commands to retrieve information with the GenTL::GCGetPortInfo function on a port handle.

Enumerator
PORT_INFO_CUSTOM_CONTROL_PROTOCOL	STRING Control protocol that the port supports.

MEMORY_TYPE_LIST

enum MEMORY_TYPE_LIST

This enumeration defines Euresys custom type of announced memory.

Enumerator
MEMORY_TYPE_BUS_ADDRESS	Bus address is already mapped and translated.
MEMORY_TYPE_DEFAULT	Default host memory.
MEMORY_TYPE_NVIDIA_RDMA	Device memory allocated for RDMA on a NVIDIA card

Function Documentation

EuresysDSAnnounceBusBuffer()

GC_API EuresysDSAnnounceBusBuffer	(	DS_HANDLE	hDataStream,
		uint64_t	busAddress,
		size_t	iSize,
		void *	reserved,
		void *	pPrivate,
		BUFFER_HANDLE *	phBuffer
	)

EuresysDSAnnounceDeviceBuffer()

GC_API EuresysDSAnnounceDeviceBuffer	(	DS_HANDLE	hDataStream,
		void *	pBuffer,
		size_t	iSize,
		MEMORY_TYPE	memType,
		void *	pPrivate,
		BUFFER_HANDLE *	phBuffer
	)

EuresysEventsGetData()

GC_API EuresysEventsGetData	(	EURESYS_EVENT_GET_DATA_ENTRY *	pEntries,
		size_t	iNumEntries,
		uint64_t *	piTimeout
	)

Wait for multiple events.

Parameters

pEntries	definition of events to wait for
iNumEntries	number of entries in pEntries
piTimeout	optional timeout to wait for events if piTimeout is NULL, EuresysEventsGetData updates pEntries with currently available events data, it returns GC_ERR_SUCCESS even if no data was available if *piTimeout == 0, EuresysEventsGetData updates pEntries with currently available events data, it returns GC_ERR_TIMEOUT if no data was available if *piTimeout != 0, EuresysEventsGetData waits for one or more events to be notified and returns available data for any event at that time, it returns GC_ERR_TIMEOUT if no data was available before the timeout expires (returns same errors as GenTL::EventGetData)

Note

pEntries[i].bGotData tells whether data was received for event pEntries[i].hEvent