User manual AMPEX DATA DST ACL APPLICATION PROGRAMMING INTERFACE (LIBACL) PROGRAMMER S GUIDE, PART NO. 1308904-X4

[. . . ] DST/DIS Automated Cartridge Library UNIX Application Programmer's Guide ® TM 1308904-X4 NOTICE The contents of this technical manual have been checked and are believed to be accurate. However, no responsibility is assumed for any inaccuracies in the information provided herein. Ampex Corporation reserves the right to make changes without notice to improve reliability, function or design. TRADEMARKS UNIX is registered trademark licensed exclusively by X/Open Co. , Ltd. DST is a registered trademark of Ampex Corporation. COPYRIGHT INFORMATION U. S. [. . . ] When set to zero, releases any outstanding reservation made by the initiator issuing the aclRelease() function--which was not a 3rd party reservation. When set to one, releases any outstanding reservation made by the initiator issuing the aclRelease() function--which was a 3rd party reservation on behalf of the same device specified by the 3rd Party Device ID (tpdid parameter). tpdid Third Party SCSI Device ID (0 -7) of the initiator reserving the ACL. This parameter is ignored when the tpr parameter is zero *tpr ENVIRONMENT When the $RETRY_ON_RESET environment variable is set, all libacl functions automatically perform one retry when a failure is caused by a SCSI Bus Device Reset of the ACL. Ampex 1308904-X4 Preliminary Draft 4-33 Running aclReleaseHead Model No. ACL Application Programmer's Guide RETURN VALUES Exit status codes are: 0 -1 DST_SUCCESS. DST_FAILURE. SEE ALSO libacl_api_intro (3), aclReserve(3) DST/DIS Automated Cartridge Library Application Programming Interface (libacl) Programmer's Guide 4-34 Preliminary Draft Ampex 1308904-X4 ACL Application Programmer's Guide aclReserve 4. 17 aclReserve (TBS) Ampex 1308904-X4 Preliminary Draft 4-35 Running Head aclReqSense Model No. ACL Application Programmer's Guide 4. 18 NAME aclReqSense aclReqSense() - retrieve ACL SCSI sense data. SYNOPSIS #include <acl. h> int aclReqSense(char *device, sense_data_t *sp, int size); Writer_Note: Should we list the sense_data_t structure in the man page and describe the structure members?Even if we do so, the supporting detail necessary to interpret the sense data is currently published only in the ICD which the customer doesn't get. I plan to include the detail in some future release of the libacl Programmer's Guide, but I have no idea when that will be as eight months have elapsed since I last had a chance to work on it. DESCRIPTION aclReqSense() issues a SCSI Request Sense command to the ACL to retrieve the current Sense Data. This function is usually called to determine the condition(s) that caused the previous function to fail. · The ACL clears Sense Data prior to executing any command other than Request Sense and sets Sense Data when a command results in a Check Condition or Command Terminated status. Sense Data is cleared after it is retrieved by a Request Sense command. In general, the ACL retains the original Sense Data when an error occurs executing a Request Sense command. However, when the error occurs parsing the command descriptor block (CDB), the original Sense Data is lost and is replaced with Sense Data corresponding to the parsing error · aclReqSense() is available to all users. PARAMETERS *device Pointer or string specifying the device special file associated with the ACL. (TBS) *sp Writer_Note: size 4-36 Preliminary Draft Ampex 1308904-X4 ACL Application Programmer's Guide aclReqSense USAGE aclReqSense() reports current Sense Data in the *sp structure. See the acl. h header file for details. ENVIRONMENT When the $RETRY_ON_RESET environment variable is set, all libacl functions automatically perform one retry when a failure is caused by a SCSI Bus Device Reset of the ACL. RETURN VALUES Exit status codes are: 0 -1 DST_SUCCESS. DST_FAILURE. SEE ALSO libacl_api_intro(3) DST/DIS Automated Cartridge Library Application Programming Interface (libacl) Programmer's Guide Ampex 1308904-X4 Preliminary Draft 4-37 Running aclRezero Head Model No. ACL Application Programmer's Guide 4. 19 NAME aclRezero aclRezero() - reset the ACL and ensure that element status is current in the internal database. SYNOPSIS #include <acl. h> int aclRezero(char *device); DESCRIPTION aclRezero() resets the ACL cartridge handling system and directs the ACL to check element status. If a discrepancy is found, the ACL re-initializes to update its internal database. aclRezero() is available to all users. PARAMETERS *device Pointer or string specifying the device special file associated with the ACL. ENVIRONMENT When the $RETRY_ON_RESET environment variable is set, all libacl functions automatically perform one retry when a failure is caused by a SCSI Bus Device Reset of the ACL. RETURN VALUES Exit status codes are: 0 -1 DST_SUCCESS. DST_FAILURE. SEE ALSO libacl_api_intro(3) DST/DIS Automated Cartridge Library Application Programming Interface (libacl) Programmer's Guide 4-38 Preliminary Draft Ampex 1308904-X4 ACL Application Programmer's Guide aclSetParam 4. 20 NAME aclSetParam aclSetParam() - change ACL configuration parameter(s). SYNOPSIS #include <acl. h> int aclSetParam(char *device, aclParam_t *param, int valid); DESCRIPTION aclSetParam() sets the behavior of the ACL by changing one or more configuration parameter settings. To check the current configuration parameter settings, use the aclGetParam() function. aclSetParam() is available to all users. PARAMETERS *device Pointer or string specifying the device special file associated with the ACL. [. . . ] Re-issue the command with a valid opcode. 29h Unrecognized SCSI Command Opcode The SCSI command contained an invalid opcode. 05h 21h 01h Illegal Request 06h Invalid Element Address The Move command cannot be completed with the addresses(es) supplied in the SCSI command. Read Element Status and verify that the addresses are valid and the move is permitted. 05h 21h 01h Illegal Request 2Dh Cartridge ID in Move Volume Command is Not in Database The ACL does not contain the cartridge you specified. Load the cartridge into the ACL or specify a different cartridge. 05h 21h 01h Illegal Request 32h Cartridge Barcode Cannot be Read The ACL cannot read the barcode label on the cartridge. Replace the barcode label. 05h 21h 01h Illegal Request 33h Invalid Source Element Address The move command cannot be completed with the source address supplied in the SCSI command. Read Element Status and verify that the addresses are valid and the move is permitted. 05h 21h 01h Illegal Request 34h Invalid Destination Element Address The move command cannot be completed with the destination address supplied in the SCSI command. Read Element Status and verify that the addresses are valid and the move is permitted. Ampex 1308904-X4 Preliminary Draft A-9 Running Head Vendor-Specific ACL Condition Codes Model No. Vendor-Specific ACL Condition Codes (Continued) Sense ASC ASCQ Key 05h 21h 01h Illegal Request ACL Condition Code 35h Condition Reported Invalid Transport Element Address. The move command cannot be completed with the transport element address supplied in the SCSI command. Recovery Procedure Read Element Status and verify that the addresses are valid and the move is permitted. 05h 21h 01h Illegal Request 36h Cartridge Movement Specified by SCSI Command is Not Allowed The move you specified is not permitted. Read Element Status to determine the Move functions permitted. 05h 24h 00h Illegal Request 28h Invalid Field in SCSI Command Descriptor Block A field in the CDB contained an invalid entry. Re-issue the command with valid values in the CDB. 05h 25h 00h Illegal Request 01h Logical Unit Number (LUN) Not Supported The LUN was not zero. Re-issue the command with the LUN set to zero. 05h 3Bh 0Dh Illegal Request 08h Move Command--Destination Storage Bin was Full The storage bin already contains a cartridge. Read Element Status to determine storage bin status. 05h 3Bh 0Dh Illegal Request 1Fh Move Command--Destination Tape Drive was Full The tape drive already contains a cartridge. Read Element Status to determine tape drive status. 05h 3Bh 0Eh Illegal Request 07h Move Command--Source Storage Bin was Empty There is no cartridge in the storage bin. Read Element Status to determine storage bin status. 05h 3Bh 0Eh Illegal Request 1Eh Move Command--Source Tape Drive was Empty There is no cartridge in the tape drive. Read Element Status to determine tape drive status. A-10 Preliminary Draft Ampex 1308904-X4 ACL Application Programmer's Guide Vendor-Specific ACL Condition Codes Table A-4. Vendor-Specific ACL Condition Codes (Continued) Sense ASC ASCQ Key 06h 29h 00h Unit Attention ACL Condition Code 69h Condition Reported Power On or Unit Reset Condition Indicates this is the first command sent by the initiator after the ACL completed a boot sequence. Recovery Procedure The application software might have to be re-initialized. 0Bh 55h B9h Aborted Command 39h CHS Failed on Put Command and Restored System to Previous Condition (8XX) The ACL was executing a Move command which involves getting a cartridge from one location and putting it in another. [. . . ]