EDT PCD SDK Documentation 6.1.0
edt_shared_types.h File Reference

(git dc05dddc, 2023-10-26)

Datatypes and configuration macros shared between userspace libraries and kernel driver source. More...

#include "edtdef.h"
Include dependency graph for edt_shared_types.h:
This graph shows which files directly or indirectly include this file:

Data Structures

struct  edt_timespec
 
struct  edt_dma_info
 

Macros

#define EDT_USER_BUFS   (1U << 0)
 
#define EDT_COPY_KBUFS   (1U << 1)
 
#define EDT_MMAP_KBUFS   (1U << 2)
 

Typedefs

typedef char edt_bitpath[128]
 
typedef struct edt_timespec edt_timespec_t
 
typedef struct edt_dma_info edt_dma_info_t
 
typedef enum edt_dma_timeout_action EdtDmaTimeoutAction
 

Enumerations

enum  edt_dma_wait_status { EDT_WAIT_UNKNOWN = -1 , EDT_WAIT_OK = 0 , EDT_WAIT_TIMEOUT = 1 , EDT_WAIT_OK_TIMEOUT = 2 }
 
enum  edt_dma_timeout_action { EDT_TIMEOUT_NULL , EDT_TIMEOUT_BIT_STROBE }
 
enum  edt_kernel_event {
}
 

Detailed Description

Datatypes and configuration macros shared between userspace libraries and kernel driver source.

Author
Alex Hogen (alex@.nosp@m.edt..nosp@m.com)

Macro Definition Documentation

◆ EDT_USER_BUFS

#define EDT_USER_BUFS   (1U << 0)
Deprecated:
Do not use.

◆ EDT_COPY_KBUFS

#define EDT_COPY_KBUFS   (1U << 1)

Use buffer copy.

◆ EDT_MMAP_KBUFS

#define EDT_MMAP_KBUFS   (1U << 2)

Use memory-mapped buffers.

Typedef Documentation

◆ edt_bitpath

typedef char edt_bitpath[128]

Typedef for edt_bitpath to send and retrieve bitfile pathnames from the driver.

◆ edt_timespec_t

typedef struct edt_timespec edt_timespec_t

Structure holding a timestamp broken down into seconds and nanoseconds.

◆ edt_dma_info_t

typedef struct edt_dma_info edt_dma_info_t

Information about active DMA operations.

See also
edt_get_dma_info().

◆ EdtDmaTimeoutAction

Timeout action.

Enumeration Type Documentation

◆ edt_dma_wait_status

Enumerator
EDT_WAIT_UNKNOWN 

Error: Unknown wait status.

◆ edt_dma_timeout_action

Timeout action.

Enumerator
EDT_TIMEOUT_NULL 

No extra action taken.

EDT_TIMEOUT_BIT_STROBE 

Flush any valid bits left in input circuits of SSDIO.

◆ edt_kernel_event

Event flag bits, indicating interest in these events.

See also
edt_set_event_func()
Enumerator
EDT_PDV_EVENT_ACQUIRE 

Image has been acquired, shutter has closed, subject can be moved if necessary, DMA will now restart.

Applicable Boards: VisionLink F1/F4

EDT_EVENT_PCD_STAT1 

Interrupt occurred on Status 1 line.

Applicable Boards: PCI CD

EDT_EVENT_PCD_STAT2 

Interrupt occurred on Status 2 line.

Applicable Boards: PCI CD

EDT_EVENT_PCD_STAT3 

Interrupt occurred on Status 3 line.

Applicable Boards: PCI CD

EDT_EVENT_PCD_STAT4 

Interrupt occurred on Status 4 line.

Applicable Boards: PCI CD

EDT_PDV_EVENT_FVAL 

Frame Valid line is set.

Applicable Boards: VisionLink F1/F4