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

SPI Concepts and Protocol
SPI Programming Manual—427506-006
2-52
Sample Error Responses
Error List Example 2
Single error list (subsystem SYSB):
<ZSPI-TKN-RETCODE> ! m (value out of range)
<ZSPI-TKN-ERRLIST>
<ZSPI-TKN-ERROR>
Z-SSID ! Subsystem ID for SYSB
Z-ERROR ! m (value out of range)
<ZSPI-TKN-PARM-ERR>
Z-TOKENCODE ! token code in error (or
! first 32 bits of token
! map)
Z-INDEX ! index of that token code
Z-OFFSET ! offset of field in error
! if token is a structure
<SYSB.ZSPI-TKN-ENDLIST> ! end of error list
In this example, the ZSPI-TKN-PARM-ERR token, whose structure is defined in
Section 4, ZSPI Data Definitions
, is used to identify which command-parameter token
contained the out-of-range value. The index value indicates the position of that token in
the buffer, and the offset denotes the position of the out-of-range field within that token
if the token value is a structure.
Error List Example 3
Nested error lists (subsystems FUP and FILESYS):
<ZSPI-TKN-RETCODE> ! x (FUP command failed
! with file-system
error)
<ZSPI-TKN-ERRLIST>
<ZSPI-TKN-ERROR>
Z-SSID ! Subsystem ID for FUP
Z-ERROR ! x (FUP command failed
! with file-system
error)
<ZFUP-MAP-CMD-ERROR>
Z-COMMAND ! LOAD command
Z-OBJECT ! FILE object type
Z-NAME ! Name of file on which
! error occurred
<ZSPI-TKN-ERRLIST> ! List from file system
<ZSPI-TKN-ERROR>
Z-SSID ! SSID of file system
Z-ERROR ! y (file-system error)
<ZSPI-TKN-PROC-ERR> ! WRITE procedure
<ZSPI-TKN-ENDLIST> ! End FILESYS error list
<ZSPI-TKN-ENDLIST> ! End FUP error list
In this example, a FUP LOAD command failed because a file-system error occurred on
a WRITE procedure call. Because the file system does not have an SPI interface, FUP
constructs an error list, on behalf of the file system, to describe the file-system error.