SPI Programming Manual (G06.24+, H06.03+, J06.03+)

SPI Concepts and Protocol
SPI Programming Manual427506-006
2-48
Error Lists
Error Lists
Except in the case of the empty response record used in continuation, if the return
token is nonzero, the response record must include at least one error list. This error list
must contain an error token (ZSPI-TKN-ERROR) with an error number that matches
the value of the return code. The response record can contain other error lists as well.
Error lists can be present in a response record even if the value of the return token is
zero. Such lists describe warnings; these are unusual conditions about which the
requester might want to know, but which do not prevent the server from completing the
command.
Normal response tokens are returned outside of error lists; but if they are necessary to
describe the error, these tokens are repeated inside the relevant error lists. Each error
list is a complete, self-contained description of an error.
Figure 2-15. Error Information in a Response Record
If ZSPI-TKN-RETCODE = error number indicating empty response message
<ZSPI-TKN-RETCODE>
(Required)
If ZSPI-TKN-RETCODE = 0 (no errors, but possibly warnings):
<ZSPI-TKN-RETCODE>
<error-list> <error-list>...
(Required) (Optional. If present, these error-lists
describe warnings)
If ZSPI-TKN-RETCODE = any other value (there is an error):
<ZSPI-TKN-RETCODE> <error-list> <error-list>...
(Required)
(Optional)
<error-list>
(Required*)
*This error list must contain a ZSPI-TKN-ERROR taken whose error-number field matches the
value of the return taoken (ZSPI-TKN-RETCODE)
VST019.vsd