GDSX Manual

USKELEX and USKELEXC Listings
Extended General Device Support (GDSX) Manual–134303
B-26
USKELEXC Listing
!
! Input: None.
! Output: None.
!
!***************************************************************************
PROC USER^BACKUP;
BEGIN
END;
!===========================================================================
?Page "PROC USER^COMMANDS"
!===========================================================================
!***************************************************************************
!
! Function: This PROC serves as a way for users to add a new SPI command.
! Unrecognized SPI commands will be passed to this PROC for
! further processing.
!
! Input: IOCB which contains the incoming SPI request
!
! Output: file^error : return file-system error code related to this I/O
! sg^error : return SPI error code for this SPI request.
! this is important if USCODE wants TSCODE to format
! response. Note that -1 means invalid command.
!
! Return 0 if standard response is OK (i.e., USCODE does not
! have any extra info to return in a response buffer),
! 1 if USCODE format the response buffer and no need
! for TSCODE to supply any response.
!
! Note that the following restriction has to follow:
! 1. incoming SPI buffer is pointed to by iocb.bufaddr
! 2. If users prepare SPI response, the response SPI
! buffer has to be pointed to by iocb.bufaddr when returns
!
!***************************************************************************
INT PROC USER^COMMANDS (iocb, file^error, sg^error) ;
INT .EXT iocb (iocb^template), ! routines for processing
.file^error , ! user's commands, functions, etc.
.sg^error ;
BEGIN
SG^ERROR := -1; ! -1 indicates that this command is unknown
RETURN 0;
END ;
!===========================================================================
?PAGE "PROC USER^INITIALIZE"
!===========================================================================
!***************************************************************************
! Function: This PROC serves as a way for users to initialize user data
! and/or special procedure before GDSX is ready to accept opens
!
! Input: INT primary : Flag to indicate whether the initialization is
! needed for primary (1), or backup (0).
!
! Output: None.
!
!***************************************************************************
PROC user^initialize(primary);
INT primary;
BEGIN
END;