Image Manager (CVCDriver.dll) 15.0

Interface for accessing registers or device memory. More...

Functions

cvbbool_t CanRegPort (IMG Image)
 This function verifies whether the image supports the RegPort interface.
 
cvbres_t RPGetInfoAsFloat (IMG Image, cvbval_t InfoCommand, double &Info)
 Retrieve information about a port from the device.
 
cvbres_t RPGetInfoAsInteger (IMG Image, cvbval_t InfoCommand, cvbint64_t &Info)
 Retrieve information about a port from the device.
 
cvbres_t RPGetInfoAsString (IMG Image, cvbval_t InfoCommand, char *szInfo, size_t &InfoSize)
 Retrieve information about a port from the device.
 
cvbres_t RPReadMem (IMG Image, cvbint64_t Address, void *TargetBuffer, size_t lBufferSize)
 Read a memory content from the device.
 
cvbres_t RPReadReg (IMG Image, cvbint64_t Address, cvbuint32_t &Value)
 Reads a 32Bit register.
 
cvbres_t RPWriteMem (IMG Image, cvbint64_t Address, void *SourceBuffer, size_t lBufferSize)
 Write a memory content to the device.
 
cvbres_t RPWriteReg (IMG Image, cvbint64_t Address, cvbuint32_t Value)
 Write a 32Bit register.
 

Detailed Description

Interface for accessing registers or device memory.

Function Documentation

◆ CanRegPort()

cvbbool_t CanRegPort ( IMG Image)

This function verifies whether the image supports the RegPort interface.

Parameters
[in]ImageHandle of image object.
Returns
TRUE if the image supports the RegPort interface, FALSE otherwise.
Supported platforms:
Win32
Win64
Linux

◆ RPGetInfoAsFloat()

cvbres_t RPGetInfoAsFloat ( IMG Image,
cvbval_t InfoCommand,
double & Info )

Retrieve information about a port from the device.

Parameters
[in]ImageHandle of image object.
[in]InfoCommandCommand ID to execute.
[out]InfoInformation to access as float.
Returns
>=0 : OK
<0 : an error occured
Supported platforms:
Win32
Win64
Linux

◆ RPGetInfoAsInteger()

cvbres_t RPGetInfoAsInteger ( IMG Image,
cvbval_t InfoCommand,
cvbint64_t & Info )

Retrieve information about a port from the device.

Parameters
[in]ImageHandle of image object.
[in]InfoCommandCommand ID to execute.
[out]InfoInformation to access as integer.
Returns
>=0 : OK
<0 : an error occured
Supported platforms:
Win32
Win64
Linux

◆ RPGetInfoAsString()

cvbres_t RPGetInfoAsString ( IMG Image,
cvbval_t InfoCommand,
char * szInfo,
size_t & InfoSize )

Retrieve information about a port from the device.

Parameters
[in]ImageHandle of image object.
[in]InfoCommandCommand ID to execute.
[in,out]szInfoBuffer to recieve string.
[in,out]InfoSizeSize of the provided buffer.
Returns
>=0 : OK
<0 : an error occured
Supported platforms:
Win32
Win64
Linux

◆ RPReadMem()

cvbres_t RPReadMem ( IMG Image,
cvbint64_t Address,
void * TargetBuffer,
size_t lBufferSize )

Read a memory content from the device.

Parameters
[in]ImageHandle of image object.
[in]AddressAddress in the device to read from.
[in,out]TargetBufferBuffer to read to.
[in,out]lBufferSizeSize to read in Bytes.
Returns
>=0 : OK
<0 : an error occured
Supported platforms:
Win32
Win64
Linux

◆ RPReadReg()

cvbres_t RPReadReg ( IMG Image,
cvbint64_t Address,
cvbuint32_t & Value )

Reads a 32Bit register.

Parameters
[in]ImageHandle of image object.
[in]AddressAddress in the device to read from.
[out]ValueValue containing the information.
Returns
>=0 : OK
<0 : an error occured
Supported platforms:
Win32
Win64
Linux

◆ RPWriteMem()

cvbres_t RPWriteMem ( IMG Image,
cvbint64_t Address,
void * SourceBuffer,
size_t lBufferSize )

Write a memory content to the device.

Parameters
[in]ImageHandle of image object.
[in]AddressAddress in the device to read from.
[in]SourceBufferBuffer to write from.
[in]lBufferSizeSize to read in Bytes.
Returns
>=0 : OK
<0 : an error occured
Supported platforms:
Win32
Win64
Linux

◆ RPWriteReg()

cvbres_t RPWriteReg ( IMG Image,
cvbint64_t Address,
cvbuint32_t Value )

Write a 32Bit register.

Parameters
[in]ImageHandle of image object.
[in]AddressAddress in the device to write to.
[in]ValueValue to write in register.
Returns
>=0 : OK
<0 : an error occured
Supported platforms:
Win32
Win64
Linux