Aim AMC429, Reference Manual

Page: 206 / 228

196 Software Library Reference Manual for VME 429
Section 10 – Troubleshooting
Error Reporting by ApiIo Function Call - Point 2
If the API S/W Library function call involves a command to the Target S/W, the ApiIo
function on the host is called by the Library function and passed the command and
the expected acknowledgement to be received from the Target S/W. If the Library
function call to ApiIo contains parameter errors, which would occur at point 2, an
"
ERROR in function call " message as shown in Figure 10.1-2 will occur with ApiIo
as the function name and one of the following error codes/error constant
definitions .
Value Constant Description
0x0010 API_ERR_WRONG_MODULE Module number is not in range
0x0017 API_ERR_PARAM5_IS_NULL Parameter 5 pointer is null
0x001B API_ERR_PARAM3_NOT_IN_RANGE Parameter 3 (CMD) is not in range
0x001C API_ERR_PARAM4_NOT_IN_RANGE Parameter 4 (expected ACK) is not
in range
0x0020 API_ERR_WRONG_BIU Biu number is not in range
0x0022 API_ERR_PARAM7_IS_NULL Parameter 7 pointer is null
0x0024 API_ERR_PARAM9_IS_NULL Parameter 9 pointer is null
0x0025 API_ERR_PARAM10_IS_NULL Parameter 10 pointer is null
0x0026 API_ERR_PARAM11_IS_NULL Parameter 11 pointer is null
0x0027 API_ERR_PARAM12_IS_NULL Parameter 12 pointer is null
0x0028 API_ERR_PARAM13_IS_NULL Parameter 13 pointer is null
0x0029 API_ERR_PARAM14_IS_NULL Parameter 14 pointer is null
The ApiIo function suspends further execution of the Target command and returns
to the calling API S/W Library function if one of the above errors is detected.
The user should examine the error message and determine whether the original
error occurred within the parameters passed by the original calling function. If so,
the user should then return to the user's program, locate the function call in question
and correct the specified error. Otherwise AIM support should be notified as
instructed at the start of section 10.
If the
ApiIo function verifies all parameters passed to it are valid and within range it
then sets up command buffers to be sent to the Target S/W and calls the appropriate
OS driver via the
_ApiIo API S/W Library function. The Target S/W attempts to
execute the Target driver command and returns status of the command and
acknowledgement information.
2