GenTL_v1_5_EuresysCustom.h

Go to the documentation of this file.

/* Copyright Euresys 2015 */

#ifndef GENTL_V1_4_EURESYS_CUSTOM_HEADER_FILE
#define GENTL_V1_4_EURESYS_CUSTOM_HEADER_FILE

#if !defined(EURESYS_GENTL_INCLUDE_ONLY_ENUM_DEFS)
#if !defined(GC_IMPORT_EXPORT) || !defined(GC_CALLTYPE)
#error Include GenTL header file before GenTL_v1_5_EuresysCustom.h
#endif

#ifdef __cplusplus
extern "C" {
namespace GenTL {
namespace EuresysCustomGenTL {
#endif
#endif

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_REVOKE_ERROR_FOLLOWING_ANNOUNCE_ERROR  = GC_ERR_CUSTOM_ID - 10,  
    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, 
    /* Following codes are custom error codes returned by the driver */
    GC_ERR_CUSTOM_IOCTL_BASE                             = -20000,                        // Reserved
    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_GET_INFO_FAILED               = GC_ERR_CUSTOM_IOCTL_BASE -  8, // Reserved
    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_DS_STOP_FAILED                   = GC_ERR_CUSTOM_IOCTL_BASE - 11, // Reserved
    GC_ERR_CUSTOM_IOCTL_DEV_GET_INFO_FAILED              = GC_ERR_CUSTOM_IOCTL_BASE - 12, // Reserved
    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_CXP_MASTER_CONNECTION_NOT_FOUND  = GC_ERR_CUSTOM_IOCTL_BASE - 16, // Reserved
    GC_ERR_CUSTOM_IOCTL_CXP_HOST_LIBRARY_CMD_FAILED      = GC_ERR_CUSTOM_IOCTL_BASE - 17, // Reserved
    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, 
};

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, 
};

enum EVENT_TYPE_CUSTOM_LIST
{
    EVENT_CUSTOM_IO_TOOLBOX             = EVENT_CUSTOM_ID + 1,      
    EVENT_CUSTOM_CIC                    = EVENT_CUSTOM_ID + 2,      
    EVENT_CUSTOM_DATASTREAM             = EVENT_CUSTOM_ID + 3,      
    EVENT_CUSTOM_CXP_INTERFACE          = EVENT_CUSTOM_ID + 4,      
};

enum EVENT_DATA_INFO_CUSTOM_CMD_LIST
{
    EVENT_DATA_CUSTOM_TIMESTAMP         = EVENT_DATA_CUSTOM_ID + 1, 
    EVENT_DATA_CUSTOM_CONTEXT_1         = EVENT_DATA_CUSTOM_ID + 2, 
    EVENT_DATA_CUSTOM_CONTEXT_2         = EVENT_DATA_CUSTOM_ID + 3, 
    EVENT_DATA_CUSTOM_CONTEXT_3         = EVENT_DATA_CUSTOM_ID + 4, 
};

#define EVENT_DATA_NUMID_CUSTOM_BASE 0x8000

enum EVENT_DATA_NUMID_CUSTOM_LIST
{
    // EVENT_CUSTOM_IO_TOOLBOX
    EVENT_DATA_NUMID_IO_TOOLBOX_LIN1                    = EVENT_DATA_NUMID_CUSTOM_BASE | 0x000,  
    EVENT_DATA_NUMID_IO_TOOLBOX_LIN2                    = EVENT_DATA_NUMID_CUSTOM_BASE | 0x001,  
    EVENT_DATA_NUMID_IO_TOOLBOX_LIN3                    = EVENT_DATA_NUMID_CUSTOM_BASE | 0x002,  
    EVENT_DATA_NUMID_IO_TOOLBOX_LIN4                    = EVENT_DATA_NUMID_CUSTOM_BASE | 0x003,  
    EVENT_DATA_NUMID_IO_TOOLBOX_LIN5                    = EVENT_DATA_NUMID_CUSTOM_BASE | 0x004,  
    EVENT_DATA_NUMID_IO_TOOLBOX_LIN6                    = EVENT_DATA_NUMID_CUSTOM_BASE | 0x005,  
    EVENT_DATA_NUMID_IO_TOOLBOX_LIN7                    = EVENT_DATA_NUMID_CUSTOM_BASE | 0x006,  
    EVENT_DATA_NUMID_IO_TOOLBOX_LIN8                    = EVENT_DATA_NUMID_CUSTOM_BASE | 0x007,  
    EVENT_DATA_NUMID_IO_TOOLBOX_QDC1                    = EVENT_DATA_NUMID_CUSTOM_BASE | 0x080,  
    EVENT_DATA_NUMID_IO_TOOLBOX_QDC1_DIR                = EVENT_DATA_NUMID_CUSTOM_BASE | 0x081,  
    EVENT_DATA_NUMID_IO_TOOLBOX_QDC2                    = EVENT_DATA_NUMID_CUSTOM_BASE | 0x082,  
    EVENT_DATA_NUMID_IO_TOOLBOX_QDC2_DIR                = EVENT_DATA_NUMID_CUSTOM_BASE | 0x083,  
    EVENT_DATA_NUMID_IO_TOOLBOX_QDC3                    = EVENT_DATA_NUMID_CUSTOM_BASE | 0x084,  
    EVENT_DATA_NUMID_IO_TOOLBOX_QDC3_DIR                = EVENT_DATA_NUMID_CUSTOM_BASE | 0x085,  
    EVENT_DATA_NUMID_IO_TOOLBOX_QDC4                    = EVENT_DATA_NUMID_CUSTOM_BASE | 0x086,  
    EVENT_DATA_NUMID_IO_TOOLBOX_QDC4_DIR                = EVENT_DATA_NUMID_CUSTOM_BASE | 0x087,  
    EVENT_DATA_NUMID_IO_TOOLBOX_DIV1                    = EVENT_DATA_NUMID_CUSTOM_BASE | 0x100,  
    EVENT_DATA_NUMID_IO_TOOLBOX_DIV2                    = EVENT_DATA_NUMID_CUSTOM_BASE | 0x101,  
    EVENT_DATA_NUMID_IO_TOOLBOX_DIV3                    = EVENT_DATA_NUMID_CUSTOM_BASE | 0x102,  
    EVENT_DATA_NUMID_IO_TOOLBOX_DIV4                    = EVENT_DATA_NUMID_CUSTOM_BASE | 0x103,  
    EVENT_DATA_NUMID_IO_TOOLBOX_MDV1                    = EVENT_DATA_NUMID_CUSTOM_BASE | 0x180,  
    EVENT_DATA_NUMID_IO_TOOLBOX_MDV2                    = EVENT_DATA_NUMID_CUSTOM_BASE | 0x181,  
    EVENT_DATA_NUMID_IO_TOOLBOX_MDV3                    = EVENT_DATA_NUMID_CUSTOM_BASE | 0x182,  
    EVENT_DATA_NUMID_IO_TOOLBOX_MDV4                    = EVENT_DATA_NUMID_CUSTOM_BASE | 0x183,  
    EVENT_DATA_NUMID_IO_TOOLBOX_DEL1_1                  = EVENT_DATA_NUMID_CUSTOM_BASE | 0x200,  
    EVENT_DATA_NUMID_IO_TOOLBOX_DEL1_2                  = EVENT_DATA_NUMID_CUSTOM_BASE | 0x201,  
    EVENT_DATA_NUMID_IO_TOOLBOX_DEL2_1                  = EVENT_DATA_NUMID_CUSTOM_BASE | 0x202,  
    EVENT_DATA_NUMID_IO_TOOLBOX_DEL2_2                  = EVENT_DATA_NUMID_CUSTOM_BASE | 0x203,  
    EVENT_DATA_NUMID_IO_TOOLBOX_DEL3_1                  = EVENT_DATA_NUMID_CUSTOM_BASE | 0x204,  
    EVENT_DATA_NUMID_IO_TOOLBOX_DEL3_2                  = EVENT_DATA_NUMID_CUSTOM_BASE | 0x205,  
    EVENT_DATA_NUMID_IO_TOOLBOX_DEL4_1                  = EVENT_DATA_NUMID_CUSTOM_BASE | 0x206,  
    EVENT_DATA_NUMID_IO_TOOLBOX_DEL4_2                  = EVENT_DATA_NUMID_CUSTOM_BASE | 0x207,  
    EVENT_DATA_NUMID_IO_TOOLBOX_USER_EVENT_1            = EVENT_DATA_NUMID_CUSTOM_BASE | 0x300,  
    EVENT_DATA_NUMID_IO_TOOLBOX_USER_EVENT_2            = EVENT_DATA_NUMID_CUSTOM_BASE | 0x301,  
    EVENT_DATA_NUMID_IO_TOOLBOX_USER_EVENT_3            = EVENT_DATA_NUMID_CUSTOM_BASE | 0x302,  
    EVENT_DATA_NUMID_IO_TOOLBOX_USER_EVENT_4            = EVENT_DATA_NUMID_CUSTOM_BASE | 0x303,  
    EVENT_DATA_NUMID_IO_TOOLBOX_EIN1                    = EVENT_DATA_NUMID_CUSTOM_BASE | 0x380,  
    EVENT_DATA_NUMID_IO_TOOLBOX_EIN2                    = EVENT_DATA_NUMID_CUSTOM_BASE | 0x381,  
    // EVENT_CUSTOM_CXP_INTERFACE
    EVENT_DATA_NUMID_CXP_INTERFACE_CRC_ERROR_CXP_A      = EVENT_DATA_NUMID_CUSTOM_BASE | 0x280,  
    EVENT_DATA_NUMID_CXP_INTERFACE_CRC_ERROR_CXP_B      = EVENT_DATA_NUMID_CUSTOM_BASE | 0x281,  
    EVENT_DATA_NUMID_CXP_INTERFACE_CRC_ERROR_CXP_C      = EVENT_DATA_NUMID_CUSTOM_BASE | 0x282,  
    EVENT_DATA_NUMID_CXP_INTERFACE_CRC_ERROR_CXP_D      = EVENT_DATA_NUMID_CUSTOM_BASE | 0x283,  
    EVENT_DATA_NUMID_CXP_INTERFACE_CRC_ERROR_CXP_E      = EVENT_DATA_NUMID_CUSTOM_BASE | 0x284,  
    EVENT_DATA_NUMID_CXP_INTERFACE_CRC_ERROR_CXP_F      = EVENT_DATA_NUMID_CUSTOM_BASE | 0x285,  
    EVENT_DATA_NUMID_CXP_INTERFACE_CRC_ERROR_CXP_G      = EVENT_DATA_NUMID_CUSTOM_BASE | 0x286,  
    EVENT_DATA_NUMID_CXP_INTERFACE_CRC_ERROR_CXP_H      = EVENT_DATA_NUMID_CUSTOM_BASE | 0x287,  
    // EVENT_CUSTOM_CIC
    EVENT_DATA_NUMID_CIC_CAMERA_TRIGGER_RISING_EDGE     = EVENT_DATA_NUMID_CUSTOM_BASE | 0x41,   
    EVENT_DATA_NUMID_CIC_CAMERA_TRIGGER_FALLING_EDGE    = EVENT_DATA_NUMID_CUSTOM_BASE | 0x42,   
    EVENT_DATA_NUMID_CIC_STROBE_RISING_EDGE             = EVENT_DATA_NUMID_CUSTOM_BASE | 0x43,   
    EVENT_DATA_NUMID_CIC_STROBE_FALLING_EDGE            = EVENT_DATA_NUMID_CUSTOM_BASE | 0x44,   
    EVENT_DATA_NUMID_CIC_ALLOW_NEXT_CYCLE               = EVENT_DATA_NUMID_CUSTOM_BASE | 0x45,   
    EVENT_DATA_NUMID_CIC_DISCARDED_CIC_TRIGGER          = EVENT_DATA_NUMID_CUSTOM_BASE | 0x46,   
    EVENT_DATA_NUMID_CIC_PENDING_CIC_TRIGGER            = EVENT_DATA_NUMID_CUSTOM_BASE | 0x47,   
    EVENT_DATA_NUMID_CIC_CXP_TRIGGER_ACK                = EVENT_DATA_NUMID_CUSTOM_BASE | 0x48,   
    EVENT_DATA_NUMID_CIC_CXP_TRIGGER_RESEND             = EVENT_DATA_NUMID_CUSTOM_BASE | 0x49,   
    EVENT_DATA_NUMID_CIC_TRIGGER                        = EVENT_DATA_NUMID_CUSTOM_BASE | 0x4a,   
    // EVENT_CUSTOM_DATASTREAM
    EVENT_DATA_NUMID_DATASTREAM_START_OF_CAMERA_READOUT = EVENT_DATA_NUMID_CUSTOM_BASE | 0x61,   
    EVENT_DATA_NUMID_DATASTREAM_END_OF_CAMERA_READOUT   = EVENT_DATA_NUMID_CUSTOM_BASE | 0x62,   
    EVENT_DATA_NUMID_DATASTREAM_START_OF_SCAN           = EVENT_DATA_NUMID_CUSTOM_BASE | 0x63,   
    EVENT_DATA_NUMID_DATASTREAM_END_OF_SCAN             = EVENT_DATA_NUMID_CUSTOM_BASE | 0x64,   
    EVENT_DATA_NUMID_DATASTREAM_REJECTED_FRAME          = EVENT_DATA_NUMID_CUSTOM_BASE | 0x65,   
    EVENT_DATA_NUMID_DATASTREAM_REJECTED_SCAN           = EVENT_DATA_NUMID_CUSTOM_BASE | 0x66,   
};
typedef unsigned long long EVENT_DATA_NUMID_CUSTOM;

enum EVENT_SPECIFIC_CIC_DISCARDED_CIC_TRIGGER_LIST
{
    EVENT_SPECIFIC_CIC_DISCARDED_CIC_TRIGGER_IMAGE_BUFFER_FULL      = 0x01, 
    EVENT_SPECIFIC_CIC_DISCARDED_CIC_TRIGGER_CYCLE_NOT_COMPLETED    = 0x02, 
    EVENT_SPECIFIC_CIC_DISCARDED_CIC_TRIGGER_MAX_PENDING_TRIGGER    = 0x04, 
    EVENT_SPECIFIC_CIC_DISCARDED_CIC_TRIGGER_DATASTREAM_IDLE        = 0x08, 
};

enum EVENT_SPECIFIC_CIC_PENDING_CIC_TRIGGER_LIST
{
    EVENT_SPECIFIC_CIC_PENDING_CIC_TRIGGER_IMAGE_BUFFER_FULL        = 0x01, 
    EVENT_SPECIFIC_CIC_PENDING_CIC_TRIGGER_CYCLE_NOT_COMPLETED      = 0x02, 
};

enum EVENT_SPECIFIC_DATASTREAM_START_OF_SCAN_LIST
{
    EVENT_SPECIFIC_DATASTREAM_START_OF_SCAN_SOFTWARE_TRIGGER        = 0x02, 
    EVENT_SPECIFIC_DATASTREAM_START_OF_SCAN_HARDWARE_TRIGGER        = 0x04, 
    EVENT_SPECIFIC_DATASTREAM_START_OF_SCAN_IMMEDIATE               = 0x08, 
};

enum EVENT_SPECIFIC_DATASTREAM_END_OF_SCAN_LIST
{
    EVENT_SPECIFIC_DATASTREAM_END_OF_SCAN_SOFTWARE_TRIGGER          = 0x02, 
    EVENT_SPECIFIC_DATASTREAM_END_OF_SCAN_HARDWARE_TRIGGER          = 0x04, 
    EVENT_SPECIFIC_DATASTREAM_END_OF_SCAN_AUTOMATIC                 = 0x08, 
    EVENT_SPECIFIC_DATASTREAM_END_OF_SCAN_DS_STOP_ACQUISITION       = 0x10, 
    EVENT_SPECIFIC_DATASTREAM_END_OF_SCAN_IMAGE_BUFFER_ALMOST_FULL  = 0x20, 
};

enum EVENT_SPECIFIC_DATASTREAM_REJECTED_FRAME_LIST
{
    EVENT_SPECIFIC_DATASTREAM_REJECTED_FRAME_IMAGE_BUFFER_FULL      = 0x01, 
    EVENT_SPECIFIC_DATASTREAM_REJECTED_FRAME_DATASTREAM_IDLE        = 0x02, 
};

#if !defined(EURESYS_GENTL_INCLUDE_ONLY_ENUM_DEFS)
GC_API   EuresysDSAnnounceBusBuffer  (DS_HANDLE hDataStream, uint64_t busAddress, size_t iSize, void *reserved, void *pPrivate, BUFFER_HANDLE *phBuffer);
GC_API_P(PEuresysDSAnnounceBusBuffer)(DS_HANDLE hDataStream, uint64_t busAddress, size_t iSize, void *reserved, void *pPrivate, BUFFER_HANDLE *phBuffer);
typedef struct S_EURESYS_EVENT_GET_DATA_ENTRY
{
    EVENT_HANDLE hEvent;    
    void        *pBuffer;   
    size_t      *piSize;    
    int          bGotData;  
} EURESYS_EVENT_GET_DATA_ENTRY;

GC_API   EuresysEventsGetData  (EURESYS_EVENT_GET_DATA_ENTRY *pEntries, size_t iNumEntries, uint64_t *piTimeout);
GC_API_P(PEuresysEventsGetData)(EURESYS_EVENT_GET_DATA_ENTRY *pEntries, size_t iNumEntries, uint64_t *piTimeout);
#endif

#if !defined(EURESYS_GENTL_INCLUDE_ONLY_ENUM_DEFS)
#ifdef __cplusplus
}
}
}
#endif
#endif

#endif