IBM: CARBK

Programming Interface Information: This information is NOT intended to be
used as Programming Interfaces of VM/ESA. It is to be used for diagnosis only.

CARBK

Prolog

Control Block Contents

CARBK DSECT

Storage Layout

Cross Reference (Contains links to field and bit definitions)

CARBK Prolog

 NAME       : HCPCARBK
 DESCRIPTION: ISFC CP Application Request/Response
              parameter list
 STATUS     : VM/ESA Version 2, Release 1.0
 DSECT      : CARBK
 FUNCTION   : Pass information between a CP application and the
              ISFC CP application mailbox.
 LOCATED BY : For outbound requests, HCPAAKIQ Queue anchor.
              For requests waiting for an OPEN to complete, TRGPNDOQ.
 CREATED BY : A CP application wishing to communicate with the
              CP mailbox or by the CP mailbox when
              information is to be delivered to a CP application.
 DELETED BY : ISFC CP application mailbox.
 SERIALIZED : None
 NOTES      :
              The CARBK parameter list holds the information related
              to a specific CP application mailbox function.
              It may contain a pointer to a string of PGEBKs that
              represent pages of data to be transmitted.
              The ACTIVATION function returns to the application
              the size of a reserved area at the begin of each
              data page. The actual data is stored below the
              reserved area.
              NOTES      : The size of the reserved area on the first
              data page is larger than the reserved area
              on subsequent data pages.
    +---------------+
    | CARBK         |
    |               |
    |               |    +------------+
    | A(PGEBK.1) ------->| PGEBK.1    |
    |               |    |  Virt.Addr |
    |               |    |  Real.Addr ------------------>*
    |               |    |  A(PGEBK.n)|---               |
    +---------------+    +------------+  |               V
                                         |  +---------------------+
                                         |  | reserved area       |
                                         |  |- - - - - - - - - - -|
                                         |  | Data contained in   |
                                         |  | this page frame...  |
                                         |  |                     |
                                         |  |                     |
                                         |  +---------------------+
                                         |
                                         V
                                   +------------+
                                   | PGEBK.n    |
                                   |  Virt.Addr |
                                   |  Real.Addr |
                                   +------------+

CARBK Control Block Content


CARBK DSECT
Hex   Dec Type/Val   Lng Label (dup)    Comments
---- ---- --------- ---- -------------- --------
0000    0 Structure      CARBK          ISFC CP Application
                                        Request/Response
0000    0 Character    8 CARAPPLT       Target CP application
0008    8 Character    8 CARNODET       Target node name
0010   16 Character    8 CARAPPLS       Source CP application
0018   24 Character    8 CARNODES       Source node name
0020   32 Signed       2 *              Reserved (path id)
0022   34 Bitstring    1 CARFUNC        Function request code
          00000001       CAROPEN        1 - Open path function
          00000002       CARTRMIT       2 - Transmit request
          00000003       CARDEACT       3 - Deactivate request
          00000004       CARCLOSE       4 - Close request
          00000005       CARFRTRG       5 - Release TRGBK request
0023   35 Bitstring    1 CARFLAGS       Flag byte:
0024   36 Address      4 CARNEXT        Pointer to next CARBK on queue
0028   40 Signed       4 CARAHND        Handle for obtaining ACTBK
                                        address
002C   44 Address      4 CARACTBK       ACTBK address
0030   48 Address      4 CARTRGBK       TRGBK address
0034   52 Address      4 CARPGECH       PGEBK chain
0038   56 Dbl-Word     8 * (2)          Reserved
          00000009       CARSIZE        (*-CARBK+7)/8 Size, in
                                        doublewords, of CARBK

CARBK Storage Layout

*** CARBK - ISFC CP Application Request/Response
*
*     +-------------------------------------------------------+
*   0 |                       CARAPPLT                        |
*     +-------------------------------------------------------+
*   8 |                       CARNODET                        |
*     +-------------------------------------------------------+
*  10 |                       CARAPPLS                        |
*     +-------------------------------------------------------+
*  18 |                       CARNODES                        |
*     +-------------+------+------+---------------------------+
*  20 |/////////////|:FUNC |:FLAGS|         CARNEXT           |
*     +-------------+------+------+---------------------------+
*  28 |         CARAHND           |         CARACTBK          |
*     +---------------------------+---------------------------+
*  30 |         CARTRGBK          |         CARPGECH          |
*     +---------------------------+---------------------------+
*  38 |///////////////////////////////////////////////////////|
*     |///////////////////////////////////////////////////////|
*     +-------------------------------------------------------+
*  48
*
*** CARBK - ISFC CP Application Request/Response