ProSoft Technology MVI69-ADM - Manual (Page 206)

Backplane API Functions MVI-ADM ♦ 'C' Programmable
Developer's Guide 'C' Programmable Application Development Module
Page 206 of 342 ProSoft Technology, Inc.
February 20, 2013
8.2 Backplane API Configuration Functions
MVIbp_GetIOConfig
Syntax
int MVIbp_GetIOConfig(MVIHANDLE handle, MVIBPIOCONFIG *ioconfig);
Parameters
handle Handle returned by previous call to MVIbp_Open
ioconfig Pointer to MVIBPIOCONFIG structure to receive configuration
information
Description
This function obtains the I/O configuration of the MVI-ADM module.
handle must be a valid handle returned from MVIbp_Open.
The MVIBPIOCONFIG structure is defined as shown:
typedef struct tagMVIBPIOCONFIG
{
WORD TotalInputSize; // Size of entire input image in words
WORD TotalOutputSize; // Size of entire output image in words
WORD DirectInputSize; // Input words available for direct access
WORD DirectOutputSize; // Output words available for direct access
WORD MsgRcvBufSize; // Max size in words for received messages
WORD MsgSndBufSize; // Max size in words for sent messages
} MVIBPIOCONFIG;
The s izes in words of the module’s input and output images are returned in the
MVIBPIOCONFIG structure pointed to by ioconfig. The TotalInputSize and
TotalOutputSize members are set equal to the size of the entire input or output
image, respectively. The DirectInputSize and DirectOutputSize members are set
equal to the number of words of the respective image that is available for direct
access via the MVIbp_WriteInputImage or MVIbpReadOutputImage functions. By
default, the direct and total sizes are equal. Refer to the MVIbp_SetIOConfig
function for more information.
The MsgRcvBufSize and MsgSndBufSize members indicate the maximum size in
words for received or sent messages, respectively. By default, these values are
both zero, indicating that messaging is disabled. Refer to the MVIbp_SetIOConfig
function for more information.
Return Value
MVI_SUCCESS No errors were encountered
MVI_ERR_NOACCESS handle does not have access
Example
MVIHANDLE handle;
MVIBPIOCONFIG ioconfig;
MVIbp_GetIOConfig(handle, &ioconfig);
printf("%d words of input image available\n", ioconfig.DirectInputSize);
printf("%d words of output image available\n", ioconfig.DirectOutputSize);