OAM interface: EDGLCSUP

EDGLCSUP maps the Library Control System interface parameter list. See Managing system-managed tape library volumes: EDGLCSUX for more information about using the OAM interface.

    Common Name:          EDGLCSUX Parameter List
    Macro ID:             EDGLCSUP
    DSECT Name:           LCSUP
    Owning Component:     DFSMSrmm (DF186)
    Eye-Catcher ID:       None
    Storage Attributes:   Subpool: 230
                          Key: N/A
                          Residency: N/A
    Size:                 See LCSUP_LENGTH
    Created by:           Callers of EDGLCSUX
    Pointed to by:        Register 1 on entry to EDGLCSUX
    Serialization:        None
    Function:             Used by EDGLCSUX and its callers to map
                          requests made from LCS installation exits

Table 1. Structure LCSUP
`Offset`	`Offset`
`Dec`	`Hex`	`Type`	`Len`	`Name(Dim)`	`Description`
`0`	`(0)`	`STRUCTURE`	`160`	`LCSUP`	`EDGLCSUX parameter list`
`0`	`(0)`	`CHARACTER`	`16`	`LCSUP_HDR`	`Control block header`
`0`	`(0)`	`CHARACTER`	`8`	`LCSUP_IDENT`	`Control block ID`
`8`	`(8)`	`UNSIGNED`	`1`	`LCSUP_VERNO`	`Control block version number`
`9`	`(9)`	`UNSIGNED`	`1`	`LCSUP_REVNO`	`Control block revision number`
`10`	`(A)`	`UNSIGNED`	`2`	`LCSUP_SUBPOOL`	`Control block subpool number`
`12`	`(C)`	`UNSIGNED`	`4`	`LCSUP_LENGTH`	`Control block length`
`Start of input fields`
`16`	`(10)`	`BIT(8)`	`1`	`LCSUP_FUNCTION`	`Requested function`
		`1... ....`		`LCSUP_ENT`	`Caller is CBRUXENT`
		`.1.. ....`		`LCSUP_EJC`	`Caller is CBRUXEJC`
		`..1. ....`		`LCSUP_CUA`	`Caller is CBRUXCUA`
		`...1 ....`		`LCSUP_VNL`	`Caller is CBRUXVNL`
		`.... 1...`		`LCSUP_ACTVNL`	`Reentry from CBRUXVNL`
`18`	`(12)`	`BIT(8)`	`1`	`LCSUP_STATUSD`	`Corresponds to MVSFLGD flag`
		`1... ....`		`LCSUP_MVOREAD`	`Owner may read volume`
		`.1.. ....`		`LCSUP_MVOUPD`	`Owner may update volume`
		`..1. ....`		`LCSUP_MVOALT`	`Owner may alter volume`
		`...1 ....`		`LCSUP_MVPROTR`	`Read-Only protection`
		`.... 1...`		`LCSUP_MVPROTU`	`Update protection`
		`.... .1..`		`LCSUP_MVMVSUSE`	`May be used on MVS system`
		`.... ..1.`		`LCSUP_MVVMUSE`	`May be used on VM system`
`19`	`(13)`	`BIT(8)`	`1`	`LCSUP_STATUSE`	`Corresponds to MVSFLGE flag`
		`1... ....`		`LCSUP_MVRETSCR`	`Return to scratch pending`
		`.1.. ....`		`LCSUP_MVREPREL`	`Replace tape pending`
		`..1. ....`		`LCSUP_MVREINIT`	`Init pending`
		`...1 ....`		`LCSUP_MVDEGAUS`	`Degauss/security erase pending`
		`.... 1...`		`LCSUP_MVROWNER`	`Return to owner pending`
		`.... .1..`		`LCSUP_MVNOWNER`	`Notify owner pending`
`20`	`(14)`	`SIGNED`	`4`	`LCSUP_LCSPL`	`Pointer to LCS parameter list`
`Start of output fields`
`24`	`(18)`	`SIGNED`	`4`	`LCSUP_LCSRC`	`Return code for LCS`
`28`	`(1C)`	`SIGNED`	`4`	`LCSUP_LCSRS`	`Reason code for LCS`
`Output fields for CBRUXVNL`
`32`	`(20)`	`CHARACTER`	`8`	`LCSUP_LOANLOC`	`Loan location`
`40`	`(28)`	`CHARACTER`	`8`	`LCSUP_LOCATION`	`Current volume location`
`48`	`(30)`	`UNSIGNED`	`1`	`LCSUP_LOCTYPE`	`Current location type`
`49`	`(31)`	`CHARACTER`	`8`	`LCSUP_DEST`	`Current volume destination`
`57`	`(39)`	`UNSIGNED`	`1`	`LCSUP_DESTYPE`	`Current destination type`
`58`	`(3A)`	`CHARACTER`	`8`	`LCSUP_HOME`	`Volume home location`
`66`	`(42)`	`UNSIGNED`	`1`	`LCSUP_HOMETYPE`	`Volume home location type`
`67`	`(43)`	`CHARACTER`	`6`	`LCSUP_RACK`	`Rack number`
`73`	`(49)`	`CHARACTER`	`6`	`LCSUP_BIN`	`Bin number`
`79`	`(4F)`	`BIT(8)`	`1`	`LCSUP_STATUS`	`Volume status (MVFLGA)`
		`1... ....`		`LCSUP_MSTFLG`	`Volume is master`
		`.1.. ....`		`LCSUP_RLSFLG`	`Volume pending release`
		`..1. ....`		`LCSUP_VRFLG`	`Vital record - do not release`
		`...1 ....`		`LCSUP_ASSFLG`	`User tape (assigned by library)`
		`.... 1...`		`LCSUP_LONFLG`	`Tape is on loan`
		`.... .1..`		`LCSUP_OPNFLG`	`Tape opened and not yet closed`
		`.... ..1.`		`LCSUP_SCRFLG`	`Volume is scratch`
		`.... ...1`		`LCSUP_OCEFLG`	`Volume recorded by O/C/EOV`
`80`	`(50)`	`BIT(8)`	`1`	`LCSUP_STATUSX`	`Volume status (MVFLGAX)`
		`1... ....`		`LCSUP_GVCFLG`	`Scratch volume claimed via GETVOLUME`
		`.1.. ....`		`LCSUP_XINFLG`	`Scratch volume has never been initialised`
		`..1. ....`		`LCSUP_INIFLG`	`Scratch volume with init action pending`
		`...1 ....`		`LCSUP_ENTFLG`	`Scratch volume waiting to enter into ATL`
		`.... 1...`		`LCSUP_FABEND`	`Abend in process when a data set closed`
		`.... .1..`		`LCSUP_FOCEAB`	`Abend probably in O/C/EOV`
		`.... ..1.`		`LCSUP_ATIFLG`	`Init required for ATL volume`
`81`	`(51)`	`BIT(8)`	`1`	`LCSUP_FLAGS`	`Flag byte`
		`1... ....`		`LCSUP_TRANSIT`	`Volume moving status`
		`.1.. ....`		`LCSUP_8197`	`If on, message EDG8197 is issued`
`82`	`(52)`	`UNSIGNED`	`1`	`LCSUP_OPMODE`	`OPMODE (like TLVOPFLG)`
		`.1.. ....`		`LCSUP_OPMODE_MAN`	`MANUAL mode`
		`..1. ....`		`LCSUP_OPMODE_REC`	`RECORDING mode`
		`...1 ....`		`LCSUP_OPMODE_WARN`	`WARNING mode`
		`.... 1...`		`LCSUP_OPMODE_PROT`	`PROTECT mode`
`84`	`(54)`	`SIGNED`	`4`	`LCSUP_TDSI`	`Tape device selection information`
`88`	`(58)`	`CHARACTER`	`72`	`LCSUP_VER2SEC`	`Version 2 section`
`88`	`(58)`	`CHARACTER`	`16`	`LCSUP_INCONTAINER`	`Container`
`88`	`(58)`	`CHARACTER`	`6`	`LCSUP_STV`	`Stacked volume`
`104`	`(68)`	`UNSIGNED`	`1`	`LCSUP_VOLUMETYPE`	`Volume type`
`105`	`(69)`	`BIT(8) IsA(LOCFLAGS)`	`1`	`LCSUP_LOCFLAGS`
		`.... 1...`		`LCSUP_HSTORE`	`Location type is STORE and HOME`
`106`	`(6A)`	`BIT(8) IsA(LOCFLAGS)`	`1`	`LCSUP_DESFLAGS`
		`.... 1...`		`LCSUP_HSTORE`	`Location type is STORE and HOME`
`End output fields for CBRUXVNL`
`160`	`(A0)`	`CHARACTER`	`0`	`LCSUP_END`	`End of LCSUP`

Table 2. Constants for LCSUP
`Len`	`Type`	`Value`	`Name`	`Description`
`Constants used to initialize the LCSUP header section`
`8`	`CHARACTER`	`EDGLCSUP`	`LCSUP_IDENTV`	`Control block ID`
`1`	`DECIMAL`	`1`	`LCSUP_VER1#`	`Version 1`
`1`	`DECIMAL`	`2`	`LCSUP_VER2#`	`Version 2`
`1`	`DECIMAL`	`2`	`LCSUP_VER#`	`Version`
`1`	`DECIMAL`	`0`	`LCSUP_REV#`	`Revision number`
`1`	`DECIMAL`	`0`	`LCSUP_SP#`	`Subpool number`
`2`	`DECIMAL`	`160`	`LCSUP_LEN#`	`Control block length`
`2`	`DECIMAL`	`88`	`LCSUP_LEN1#`
`2`	`DECIMAL`	`160`	`LCSUP_LEN2#`
`Constants used to test the location type fields`
`1`	`DECIMAL`	`0`	`LCSUP_TYPE_SHELF`	`Shelf location type`
`1`	`DECIMAL`	`1`	`LCSUP_TYPE_STORE`	`Store location type`
`1`	`DECIMAL`	`2`	`LCSUP_TYPE_MTL`	`MTL location type`
`1`	`DECIMAL`	`3`	`LCSUP_TYPE_ATL`	`ATL location type`
`1`	`NUMB HEX`	`00`	`LCSUP_VOLUMETYPE_PHYSICAL`
`1`	`NUMB HEX`	`01`	`LCSUP_VOLUMETYPE_LOGICAL`
`Constants for return codes in R15`
`1`	`DECIMAL`	`0`	`LCSUP_RC_OK`	`Success reason code is set`
`1`	`DECIMAL`	`4`	`LCSUP_RC_SSNA`	`DFSMSrmm subsystem not available`
`1`	`DECIMAL`	`8`	`LCSUP_RC_LERR`	`Logical error`
`1`	`DECIMAL`	`12`	`LCSUP_RC_ENV`	`Environment error`
`Constants for reason codes in R0 when R15 = LCSUP_RC_OK`
`1`	`DECIMAL`	`0`	`LCSUP_RS_OK`	`Request successfully processed`
`1`	`DECIMAL`	`1`	`LCSUP_RS_NOACTION`	`No action performed by RMM`
`1`	`DECIMAL`	`2`	`LCSUP_RS_DONT`	`Do not need RMM exits to be called`
`Constants for reason codes in R0 when R15 = LCSUP_RC_ENV`
`1`	`DECIMAL`	`1`	`LCSUP_RS_IDENT`	`Incorrect value in LCSUP_IDENT`
`1`	`DECIMAL`	`2`	`LCSUP_RS_VERNO`	`Incorrect value in LCSUP_VERNO`
`1`	`DECIMAL`	`3`	`LCSUP_RS_REVNO`	`Incorrect value in LCSUP_REVNO`
`1`	`DECIMAL`	`4`	`LCSUP_RS_SUBPOOL`	`Incorrect value in LCSUP_SUBPOOL`
`1`	`DECIMAL`	`5`	`LCSUP_RS_LENGTH`	`Incorrect value in LCSUP_LENGTH`
`1`	`DECIMAL`	`6`	`LCSUP_RS_FUNCTION`	`Incorrect value in LCSUP_FUNCTION`
`1`	`DECIMAL`	`7`	`LCSUP_RS_NSUPV`	`EDGLCSUX not in supervisor state`
`1`	`DECIMAL`	`8`	`LCSUP_RS_LCSUP`	`EDGLCSUX parameter list could not be addressed`
`1`	`DECIMAL`	`9`	`LCSUP_RS_CBRPL`	`CBRUXXPL parameter list could not be addressed`
`1`	`DECIMAL`	`10`	`LCSUP_RS_ABEND`	`EDGLCSUX abended`
`Constants for reason codes returned in LCSUP_LCSRS`
`1`	`DECIMAL`	`1`	`LCSUP_RS_PBD`	`Inconsistent parameter list`
`1`	`DECIMAL`	`2`	`LCSUP_RS_NMV`	`Volume not to be used with MVS`
`1`	`DECIMAL`	`3`	`LCSUP_RS_DEB`	`Specified destination is not the current library`
`1`	`DECIMAL`	`4`	`LCSUP_RS_RJP`	`Undefined volume is rejected by reject prefix`
`1`	`DECIMAL`	`5`	`LCSUP_RS_SCR`	`Private to scratch change invalid`
`1`	`DECIMAL`	`6`	`LCSUP_RS_IVU`	`User ID not valid for RMM`
`1`	`DECIMAL`	`7`	`LCSUP_RS_RPX`	`Retention period exceeds installation maximum`
`1`	`DECIMAL`	`8`	`LCSUP_RS_NRM`	`Volume is not RMM managed`
`1`	`DECIMAL`	`9`	`LCSUP_RS_RIU`	`Rack to match volume serial number is not available`
`1`	`DECIMAL`	`10`	`LCSUP_RS_NSL`	`Label type is not supported in a library`
`1`	`DECIMAL`	`11`	`LCSUP_RS_IRK`	`Volume rack inconsistent`
`1`	`DECIMAL`	`12`	`LCSUP_RS_REL`	`Volume pending release`
`1`	`DECIMAL`	`13`	`LCSUP_RS_STA`	`Volume status is scratch`
`1`	`DECIMAL`	`14`	`LCSUP_RS_INI`	`Volume init action pending`
`1`	`DECIMAL`	`15`	`LCSUP_RS_DUPLV`	`Logical volume duplicates physical volume`
`1`	`DECIMAL`	`16`	`LCSUP_RS_NOTEXP`	`Logical volume is not exported`
`1`	`DECIMAL`	`17`	`LCSUP_RS_DUPPV`	`Physical volume duplicates logical volume`
`1`	`DECIMAL`	`18`	`LCSUP_RS_SMM`	`Entry volume status mismatch`
`1`	`DECIMAL`	`19`	`LCSUP_RS_DUPSV`	`Volume duplicates stacked volume`
`1`	`DECIMAL`	`20`	`LCSUP_RS_IDL`	`Volume entry not processed`
`1`	`DECIMAL`	`21`	`LCSUP_RS_PRI`	`Volume ignored by PRTITION TYPE(RMM)`
`1`	`DECIMAL`	`22`	`LCSUP_RS_PNI`	`Volume ignored by PRTITION TYPE(NORMM)`

Table 3. Cross Reference for LCSUP
`Name`	`Offset`	`Hex Tag`	`Level`
`LCSUP`	`0`		`1`
`LCSUP_ACTVNL`	`10`	`08`	`3`
`LCSUP_ASSFLG`	`4F`	`10`	`3`
`LCSUP_ATIFLG`	`50`	`02`	`3`
`LCSUP_BIN`	`49`		`2`
`LCSUP_CUA`	`10`	`20`	`3`
`LCSUP_DESFLAGS`	`6A`		`3`
`LCSUP_DEST`	`31`		`2`
`LCSUP_DESTYPE`	`39`		`2`
`LCSUP_EJC`	`10`	`40`	`3`
`LCSUP_END`	`A0`		`2`
`LCSUP_ENT`	`10`	`80`	`3`
`LCSUP_ENTFLG`	`50`	`10`	`3`
`LCSUP_FABEND`	`50`	`08`	`3`
`LCSUP_FLAGS`	`51`		`2`
`LCSUP_FOCEAB`	`50`	`04`	`3`
`LCSUP_FUNCTION`	`10`		`2`
`LCSUP_GVCFLG`	`50`	`80`	`3`
`LCSUP_HDR`	`0`		`2`
`LCSUP_HOME`	`3A`		`2`
`LCSUP_HOMETYPE`	`42`		`2`
`LCSUP_HSTORE`	`69`	`08`	`4`
`LCSUP_HSTORE`	`6A`	`08`	`4`
`LCSUP_IDENT`	`0`		`3`
`LCSUP_INCONTAINER`	`58`		`3`
`LCSUP_INIFLG`	`50`	`20`	`3`
`LCSUP_LCSPL`	`14`		`2`
`LCSUP_LCSRC`	`18`		`2`
`LCSUP_LCSRS`	`1C`		`2`
`LCSUP_LENGTH`	`C`		`3`
`LCSUP_LOANLOC`	`20`		`2`
`LCSUP_LOCATION`	`28`		`2`
`LCSUP_LOCFLAGS`	`69`		`3`
`LCSUP_LOCTYPE`	`30`		`2`
`LCSUP_LONFLG`	`4F`	`08`	`3`
`LCSUP_MSTFLG`	`4F`	`80`	`3`
`LCSUP_MVDEGAUS`	`13`	`10`	`3`
`LCSUP_MVMVSUSE`	`12`	`04`	`3`
`LCSUP_MVNOWNER`	`13`	`04`	`3`
`LCSUP_MVOALT`	`12`	`20`	`3`
`LCSUP_MVOREAD`	`12`	`80`	`3`
`LCSUP_MVOUPD`	`12`	`40`	`3`
`LCSUP_MVPROTR`	`12`	`10`	`3`
`LCSUP_MVPROTU`	`12`	`08`	`3`
`LCSUP_MVREINIT`	`13`	`20`	`3`
`LCSUP_MVREPREL`	`13`	`40`	`3`
`LCSUP_MVRETSCR`	`13`	`80`	`3`
`LCSUP_MVROWNER`	`13`	`08`	`3`
`LCSUP_MVVMUSE`	`12`	`02`	`3`
`LCSUP_OCEFLG`	`4F`	`01`	`3`
`LCSUP_OPMODE`	`52`		`2`
`LCSUP_OPMODE_MAN`	`52`	`40`	`3`
`LCSUP_OPMODE_PROT`	`52`	`08`	`3`
`LCSUP_OPMODE_REC`	`52`	`20`	`3`
`LCSUP_OPMODE_WARN`	`52`	`10`	`3`
`LCSUP_OPNFLG`	`4F`	`04`	`3`
`LCSUP_RACK`	`43`		`2`
`LCSUP_REVNO`	`9`		`3`
`LCSUP_RLSFLG`	`4F`	`40`	`3`
`LCSUP_SCRFLG`	`4F`	`02`	`3`
`LCSUP_STATUS`	`4F`		`2`
`LCSUP_STATUSD`	`12`		`2`
`LCSUP_STATUSE`	`13`		`2`
`LCSUP_STATUSX`	`50`		`2`
`LCSUP_STV`	`58`		`4`
`LCSUP_SUBPOOL`	`A`		`3`
`LCSUP_TDSI`	`54`		`2`
`LCSUP_TRANSIT`	`51`	`80`	`3`
`LCSUP_VERNO`	`8`		`3`
`LCSUP_VER2SEC`	`58`		`2`
`LCSUP_VNL`	`10`	`10`	`3`
`LCSUP_VOLUMETYPE`	`68`		`3`
`LCSUP_VRFLG`	`4F`	`20`	`3`
`LCSUP_XINFLG`	`50`	`40`	`3`
`LCSUP_8197`	`51`	`40`	`3`