gtpd2m16Data Communications Services Reference

Application Interface

Interface Conventions

Input

The following inputs will be expected by the Application Recovery Package:

INPUT:
 
Register-Conventions =
 
R1                Address of Parameter List
R7                Address of Save Area
 
Save Area Format =
 
Word              Contents
 
 0                Not Used:  Reserved for Future Use
 1                Address of Previous Save Area
 2                Address of Next Save Area
 3                Register 0 (R0)
 4                Register 1 (R1)
 5                Register 2 (R2)
 6                Register 3 (R3)
 7                Register 4 (R4)
 8                Register 5 (R5)
 9                Register 6 (R6)
 
Parameter List Format =

Will consist of consecutive fullwords starting on a fullword boundary, each fullword containing an address to be passed. Register 1 (R1) contains the address of the start of the parameter list:

Word              Contents
 
 0                Address of user supplied RCPL (RC0PL)
                                  OR
                  Address of core slot (AR0RT)
 
 1                Address of input parameter area.
 
                  This parameter area consists of:
 
                  Byte 0 - Request Indicator
 
                      The following equates are used to set the bit
                      request indicators:
 
                      SET = AR0OBTN   obtain a slot  (via ENTRC ARP1)
                            AR0DLET   delete a slot  (via ENTRC ARP2 or ARP1)
                            AR0FILE   file a message (via ENTRC ARP1)
                            AR0LOCA   locate a slot  (via ENTRC ARP2 or ARP1)
 
                      The following equate is used to identify the
                      address in word 0:
 
                      SET = AR0SLOC   core slot
 
                            if not on RCPL address
 
                  Byte 1 - Level to File core block from for File Request
 
                      The following equates are used to indicate
                      the level:
 
                      SET = D0        for level 0
                            D1        for level 1
                            D2        for level 2
                            D3        for level 3
                            D4        for level 4
                            D5        for level 5
                            D6        for level 6
 
                      Note:   For the level specified, the file address
                              reference word (CE1FMx) must be zero if
                              the AR Package is to obtain the file
                              address.  If not zero, it contains the
                              user supplied address.
 
                  Byte 2-5 - Available for address of ART slot on
                      return from obtain/locate request.  Otherwise
                      ignored.
 
                  Byte 6-17 - Work area required for delete request
                      only, else ignored.  Used by RLCHA macro (RLCHA).

Output

The following output will be expected from the Application Recovery Package. Return is via BACKC.

Registers:
 
R1                Address of parameter list
R7                Address of save area
R14-R15           Contents unknown
All others        Restored prior to return
 
Parameter List:
 
Word 0            Unchanged (except on delete request, if core slot
                  address was supplied, it will be zeroed)
 
                  Input Area referenced by word 1:
 
Word 1            Byte 0      request indicator is zeroed.
 
                  Byte 1      level indicator is zeroed.
 
                  Byte 2-5    ART core slot address (normal return,
                              except on delete request when it is
                              zeroed).
 
                  Byte 6-17   If provided, no valid user data on
                              return.
 
ECB Work Area:
 
CE1FMx            May contain file address (file request only)
 
EBCM01            Error return indicator
 
                  (Reference AR0RT, Application Recovery Table, for
                  equates used to identify possible error returns.)
 
ART Work Area:
 
AR0SY1-SY2        Indicators are turned off at completion of request.

Examples

To Obtain A Slot

INPUT:
 
     Parameter List:
 
       Word 0     Address of user supplied RCPL
       Data Area: Byte 0      AR0OBTN - request to obtain a slot
                  Byte 1      Not used
                  Byte 2-5    Available
OUTPUT:
 
     Parameter List:
 
       Word 0     Unchanged from input
       Data Area: Byte 0      Obtain indicator zeroed
                  Byte 1      Unchanged
                  Byte 2-5    Address of ART core slot for application
                              use.

To File A Message

INPUT:
 
     Parameter List:
 
       Word 0     Address of ART core slot
 
                  Note:   If RCPL address is supplied, this program
                          will search ART to locate ART core slot
                          for update.
 
       Data Area: Byte 0      AR0FILE+AR0SLOC
                              (to file slot and core address supplied
                              in word 0)
                  Byte 1      D4 - data on level 4
                  Byte 2-5    Available
 
     ECB Work Area:
 
       CE1FM4     Zeroed
 
     ART Slot Work Area:
 
       AR0SY1=
       AR0KYPT    Keypoint request during time-initiated keypoint.
 
OUTPUT:
 
     Parameter List:
 
       Word 0     Unchanged from input
       Data Area: Byte 0      Indicators zeroed
                  Byte 1      Level indicator turned off
                  Byte 2-5    Address of ART core slot
 
     ECB Work Area:
 
       CE1FM4     File address
 
     ART Slot Work Area:
 
       AR0SY1     Keypoint indicator turned off
       AR0SY1=
       AR0RLSE    AR package supplied file address.
       AR0FAW     File address (same as CE1FM4)

To Locate A Slot

INPUT:
 
     Parameter List:
 
       Word 0     User supplied RCPL address
       Data Area: Byte 0      AR0LOCA
                  Byte 1      Not used
                  Byte 2-5    Available
 
OUTPUT:
 
     Parameter List:
 
       Word 0     Unchanged from input
       Data Area: Byte 0      Locate indicator zeroed
                  Byte 1      Unchanged
                  Byte 2-5    Address of ART core slot

To Delete A Slot Reference

INPUT:
 
     Parameter List:
 
       Word 0     RCPL address
       Data Area: Byte 0      AR0DLET
                  Byte 1      Not used
                  Byte 2-5    Available
                  Byte 6-17   Work area
 
 
OUTPUT:
 
     Parameter List:
 
       Word 0     RCPL address (if ART core slot supplied:  this
                  field is zeroed).
 
       Data Area: Byte 0      Delete indicator zeroed (if ART core slot
                              supplied:  core slot indicator is zeroed).
                  Byte 1      Not used
                  Byte 2-5    Zeroed
                  Byte 6-17   No valid data

To Locate A Slot

(Previous obtain not done)
 
INPUT:
 
     Parameter List:
 
       Word 0     RCPL address
       Data Area: Byte 0      AR0LOCA
                  Byte 1      Not used
                  Byte 2-5    Available
 
OUTPUT:
 
     Parameter List:
 
       Word 0     Unchanged from input
       Data Area: Byte 0      Zeroed
 
     ECB Work Area:
 
       ECBM01=
       AR0NBR4    Slot not found