EGrabber Reference  10.2.2.73
Modules | Enumerations
Custom GenTL (C API)

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

Modules

 Euresys Events
 Definition of Euresys Coaxlink-specific Events.
 

Enumerations

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_GENAPI_ERROR = GC_ERR_CUSTOM_ID - 100, GC_ERR_CUSTOM_IMAGE_ERROR = GC_ERR_CUSTOM_ID - 200, 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
}
 This enumeration defines Euresys custom errors (GenTL::GC_ERROR) 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
}
 This enumeration defines Euresys custom commands to retrieve information with the GenTL::DSGetBufferInfo function on a buffer handle. More...
 
GC_API EuresysDSAnnounceBusBuffer (DS_HANDLE hDataStream, uint64_t busAddress, size_t iSize, void *reserved, void *pPrivate, BUFFER_HANDLE *phBuffer)
 

Detailed Description

Euresys Custom GenTL low-level C API.

Enumeration Type Documentation

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_GENAPI_ERROR 

A GenApi error has occurred.

GC_ERR_CUSTOM_IMAGE_ERROR 

An error occurred while processing an image.

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.

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.

BUFFER_INFO_CUSTOM_STREAM_LINE_WIDTH 

SIZET Value of data stream LineWidth when the buffer was announced.

BUFFER_INFO_CUSTOM_STREAM_LINE_PITCH 

SIZET Value of data stream LinePitch when the buffer was announced.

BUFFER_INFO_CUSTOM_STREAM_STRIPE_HEIGHT 

SIZET Value of data stream StripeHeight when the buffer was announced.

BUFFER_INFO_CUSTOM_STREAM_STRIPE_PITCH 

SIZET Value of data stream StripePitch when the buffer was announced.

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.

Function Documentation

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