GigE.h

Go to the documentation of this file.

#ifndef GIGE_H
#define GIGE_H
 
#include <stdint.h>
 
#define GEV_MAJOR_VERSION 0x0002
#define GEV_MINOR_VERSION 0x0000
 
const int GVSP_DFLT_PKT_SIZE = 1250;
 
// Network Packet Defines
const uint16_t  GVCP_PORT           = 3956;
 
 
const uint8_t   GVCP_HEADER_KEY     = 0x42;     
 
#define GVCP_MAX_DATAGRAM_SIZE          576
#define GVCP_HEADER_SIZE                8
#define MAX_GVSP_BUFFER_LENGTH          65536
#define IP_UDP_HEADER_SIZE              28
 
 
// These error codes match the GenCP error codes.
typedef uint16_t GEV_STATUS;
const GEV_STATUS    GEV_STATUS_SUCCESS            = 0x0000;     
const GEV_STATUS    GEV_STATUS_NOT_IMPLEMENTED    = 0x8001;     
const GEV_STATUS    GEV_STATUS_INVALID_PARAMETER  = 0x8002;     
const GEV_STATUS    GEV_STATUS_INVALID_ADDRESS    = 0x8003;     
const GEV_STATUS    GEV_STATUS_WRITE_PROTECT      = 0x8004;     
const GEV_STATUS    GEV_STATUS_BAD_ALIGNMENT      = 0x8005;     
const GEV_STATUS    GEV_STATUS_ACCESS_DENIED      = 0x8006;     
const GEV_STATUS    GEV_STATUS_BUSY               = 0x8007;     
const GEV_STATUS    GEV_STATUS_PACKET_UNAVAILABLE = 0x800C;     
const GEV_STATUS    GEV_STATUS_DATA_OVERRUN       = 0x800D;     
const GEV_STATUS    GEV_STATUS_INVALID_HEADER     = 0x800E;     
const GEV_STATUS    GEV_STATUS_ACTION_LATE        = 0x8016;     
const GEV_STATUS    GEV_STATUS_ERROR              = 0x8FFF;     
 
 
 
// GVCP
 
//IP Configuration Commands
const uint16_t eeDISCOVERY_CMD      = 0x0002;          
const uint16_t eeFORCEIP_CMD        = 0x0004;          
 
//Streaming related commands
const uint16_t eePACKETRESEND_CMD   = 0x0040;         
 
// Device memory access related commands
const uint16_t eeREADREG_CMD        = 0x0080;         
const uint16_t eeWRITEREG_CMD       = 0x0082;         
const uint16_t eeREADMEM_CMD        = 0x0084;         
const uint16_t eeWRITEMEM_CMD       = 0x0086;         
 
//ACK defines
const uint16_t eeDISCOVERY_ACK      = 0x0003;
const uint16_t eeFORCEIP_ACK        = 0x0005;
const uint16_t eeREADREG_ACK        = 0x0081;
const uint16_t eeWRITEREG_ACK       = 0x0083;
const uint16_t eeREADMEM_ACK        = 0x0085;
const uint16_t eeWRITEMEM_ACK       = 0x0087;
 
#pragma pack(push,8)
 
 
 
const uint8_t GVCP_FLAG_ACKREQ          = 0x01;     
//const uint8_t GVCP_FLAG_RETRAN        = 0x02;     //!< 
const uint8_t GVCP_FLAG_DISCOVERY_BCAST = 0x10;     
const uint8_t GVCP_FLAG_FORCEIP_BCAST   = 0x10;     
 
 
typedef struct
{
    uint8_t  key;               
    uint8_t  flags;             
    uint16_t cmnd;              
    uint16_t length;            
    uint16_t req_id;            
} tsGvcpCmdHdr;
 
typedef struct
{
    tsGvcpCmdHdr hdr;           
    uint32_t address;           
    // Note we could have more address if we want to support multi register read see GigE spec [R-158cd]
} tsGvcpCmdReadReg;
 
typedef struct
{
    tsGvcpCmdHdr hdr;           
    uint32_t address;           
    uint32_t nvalue;            
    // Note we could have more address & data if we want to support multi register write see GigE spec [R-167cd]
} tsGvcpCmdWriteReg;
 
typedef struct
{
    tsGvcpCmdHdr hdr;           
    uint32_t address;           
    uint16_t reserved;          
    uint16_t count;             
} tsGvcpCmdReadMem;
 
 
const int GVCP_MAX_WRITEMEM_BYTES = 536;
 
typedef struct
{
    tsGvcpCmdHdr hdr;           
    uint32_t address;           
    uint8_t  data[GVCP_MAX_WRITEMEM_BYTES]; 
} tsGvcpCmdWriteMem;
 
 
typedef struct
{
    tsGvcpCmdHdr hdr;           
    uint16_t reserved0;         
    uint8_t  macaddr[6];        
    uint32_t reserved1;         
    uint32_t reserved2;         
    uint32_t reserved3;         
    uint32_t static_ip;         
    uint32_t reserved4;         
    uint32_t reserved5;         
    uint32_t reserved6;         
    uint32_t static_sn;         
    uint32_t reserved7;         
    uint32_t reserved8;         
    uint32_t reserved9;         
    uint32_t static_gw;         
} tsGvcpCmdForceIP;
 
typedef struct
{
    tsGvcpCmdHdr hdr;              
    uint16_t stream_channel_index; 
    uint16_t block_id;             
    uint32_t first_packet_id;      
    uint32_t last_packet_id;       
    uint32_t block_id64_high;      
    uint32_t block_id64_low;       
} tsGvcpCmdPacketResend;
 
typedef struct
{
    uint16_t status;
    uint16_t ack;
    uint16_t length;
    uint16_t ack_id;
} tsGvcpAckHdr;
 
#pragma pack(push, 1)
typedef struct {
    union {
        struct {
            uint16_t spec_version_major;
            uint16_t spec_version_minor;
        };
        uint32_t spec_version;
    };
    uint32_t device_mode;
    uint16_t reserved1;
    uint16_t device_MAC_high;
    uint32_t device_MAC_low;
    uint32_t ip_conf_opt;
    uint32_t ip_conf_cur;
    uint32_t reserved2[3];
    uint32_t current_ip;
    uint32_t reserved3[3];
    uint32_t current_subnet;
    uint32_t reserved4[3];
    uint32_t default_gateway;
    uint8_t manufacturer_name[32];
    uint8_t model_name[32];
    uint8_t device_version[32];
    uint8_t manufacturer_specific[48];
    uint8_t serial_number[16];
    uint8_t user_defined_name[16];
 
} DiscoveryInfo;
#pragma pack(pop)
 
typedef struct
{
    tsGvcpAckHdr hdr;           
    union {
        char  bootstrap_info[sizeof(DiscoveryInfo)];
        DiscoveryInfo bootstrap_struct;
    };
} DISCOVERY_ACK_STRUCT;
 
const int DISCOVERY_ACK_PAYLOAD_SIZE = sizeof(DiscoveryInfo);
 
typedef struct
{
    tsGvcpAckHdr hdr;           
    uint32_t data;
    // Note we could have more data if we want to support multi register read see GigE spec [R-158cd]
} READREG_ACK_STRUCT;
 
 
typedef struct
{
    tsGvcpAckHdr hdr;           
    uint16_t reserved;          
    uint16_t index;             
} WRITEREG_ACK_STRUCT;
 
 
const uint16_t READMEM_MAXLEN = GVCP_MAX_DATAGRAM_SIZE;
typedef struct
{
    tsGvcpAckHdr hdr;           
    uint32_t address;
    uint8_t  data[READMEM_MAXLEN];
} READMEM_ACK_STRUCT;
 
 
typedef struct
{
    tsGvcpAckHdr hdr;           
    uint16_t reserved;          
    uint16_t index;             
} WRITEMEM_ACK_STRUCT;
 
 
typedef struct
{
    tsGvcpAckHdr hdr;           
} FORCEIP_ACK_STRUCT;
 
 
#define ACQUISITION_MODE_CONTINUOUS 1
#define ACQUISITION_MODE_SINGLE     2
#define ACQUISITION_MODE_MULTIPLE   3
 
 
//GVSP
 
const uint16_t GEV_FLAG_PREVIOUS_BLOCK_DROPPED = 0x0002;
 
typedef struct
{
    uint16_t    status;         //<! Status (usually GEV_STATUS_SUCCESS).
    uint16_t    flags;          //<! GVSP stream status flag information.
    uint8_t     eipf;           //<! bit 0 EI flag, bits 4-7 packet format ("MSB 0 bit numbering").
    uint8_t     reserved[3];    //<! Reserved set to zero.
    uint32_t    blkid_hi;       //<! Block ID number, high bytes.
    uint32_t    blkid_lo;       //<! Block ID number, low bytes.
    uint32_t    pktid;          //<! Packet ID.
} tsGvspHdrExtended;
 
typedef struct
{
    uint16_t    status;         //<! Status (usually GEV_STATUS_SUCCESS).
    uint16_t    blkid;          //<! Block ID number.
    uint8_t     eipf;           //<! bit 0 EI flag, bits 4-7 packet format ("MSB 0 bit numbering").
    uint8_t     pktid[3];       //<! 3 bytes of packet ID, byte zero MSB of ID number.
} tsGvspHdrLegacy;
 
 
typedef struct
{
    uint8_t     field_id_and_count; //always set to 0
    uint8_t     reserved;
    uint16_t    payload_type; //0x0001 or 0x4001
    uint32_t    timestamp_high;
    uint32_t    timestamp_low;
    uint32_t    pixel_format;
    uint32_t    size_x;
    uint32_t    size_y;
    uint32_t    offset_x;
    uint32_t    offset_y;
    uint16_t    padding_x;
    uint16_t    padding_y;
} tsGvspImageLeader;
 
typedef struct
{
    uint16_t    reserved;
    uint16_t    payload_type; //0x0001 or 0x4001
    uint32_t    size_y;
} tsGvspImageTrailer;
 
#pragma pack(pop)
 
#endif // GIGE_H