Interface for accessing registers or device memory.
More...
|
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.
|
|
Interface for accessing registers or device memory.
◆ CanRegPort()
cvbbool_t CanRegPort |
( |
IMG | Image | ) |
|
This function verifies whether the image supports the RegPort interface.
- Parameters
-
[in] | Image | Handle 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] | Image | Handle of image object. |
[in] | InfoCommand | Command ID to execute. |
[out] | Info | Information 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] | Image | Handle of image object. |
[in] | InfoCommand | Command ID to execute. |
[out] | Info | Information 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] | Image | Handle of image object. |
[in] | InfoCommand | Command ID to execute. |
[in,out] | szInfo | Buffer to recieve string. |
[in,out] | InfoSize | Size 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] | Image | Handle of image object. |
[in] | Address | Address in the device to read from. |
[in,out] | TargetBuffer | Buffer to read to. |
[in,out] | lBufferSize | Size 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] | Image | Handle of image object. |
[in] | Address | Address in the device to read from. |
[out] | Value | Value 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] | Image | Handle of image object. |
[in] | Address | Address in the device to read from. |
[in] | SourceBuffer | Buffer to write from. |
[in] | lBufferSize | Size 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] | Image | Handle of image object. |
[in] | Address | Address in the device to write to. |
[in] | Value | Value to write in register. |
- Returns
- >=0 : OK
<0 : an error occured
- Supported platforms:
- Win32
Win64
Linux