manualshive.com logo in svg

Spectra Logic Spectra 2k, Develop Manual, Page: 11 / 61

Share
Download
Spectra Logic Spectra 2k Develop Manual Download Page 11

Chapter 1.  Introduction

11

Contents of this Guide

This guide contains the following information:

• Description of the SCSI messages used by the Spectra 2K library.

• Description of SCSI command formats, command field definitions, and command 

status bytes.

• Detailed descriptions of single commands used by the library.

• Descriptions of the SCSI error codes returned by the library.

Related Publications

The following publications are also available from Spectra Logic:

•

Spectra 2K Library User Guide 

(P.N. 90870782) describes the installation and 

operation of the Spectra 2K library, including troubleshooting information.

•

Spectra 2K Library Release Notes 

(P.N. 90870784) provides last-minute information 

about the Spectra 2K library.

Spectra Logic Contact Information 

 

Note:

All library documentation is available in electronic format.

United States Headquarters

European Office

Mailing 
Address

Spectra Logic Corporation 
1700 N 55th Street 
Boulder CO 80301
USA 

Mailing 
Address

Spectra Logic Europe Limited
Hampden House
Monument Business Park
Warpsgrove Lane
Chalgrove Oxon
UK-OX44 7RW

Phone
Fax

(800) 833-1132 or (303) 449-6400
(303) 939-8844

Phone
Fax

+44 (0) 870 112 2150
+44 (0) 870 112 2175

Web Site

http://www.SpectraLogic.com

Summary of Contents for Spectra 2k

Page 1: ...P N 90870750 Revision C Spectra 2K Library Developer Guide ...

Page 2: ...uption of business or for indirect special incidental or consequential damages of any kind even if Spectra Logic has been advised of the possibility of such damages arising from any defect or error Information furnished in this manual is believed to be accurate and reliable However no responsibility is assumed by Spectra Logic for its use Because of continuing research and development Spectra Logi...

Page 3: ... failure of Java technology could lead directly to death personal injury or severe physical or environmental damage No liability for certain damages Except as prohibited by law Software Suppliers shall have no liability for any indirect special consequential or incidental damages arising from or in connection with the use or performance of the Software This limitation shall apply even if any remed...

Page 4: ...ventions Used in this Guide 12 Chapter 2 Initialize Element Status 07h 13 Command Description 13 Chapter 3 Initialize Element Status With Range E7h 14 Command Description 14 Chapter 4 Inquiry 12h 15 Command Description 15 Chapter 5 Mode Select 15h 20 Command Description 20 Chapter 6 Mode Sense 1Ah 22 Command Description 22 ...

Page 5: ...on 32 Chapter 9 Prevent Allow Medium Removal 1Eh 33 Command Description 33 Chapter 10 Read Element Status B8h 34 Command Description 34 Element Descriptors 37 Chapter 11 Test Unit Ready 00h 43 Command Description 43 Chapter 12 Release 17h 44 Command Description 44 Chapter 13 Request Sense 03h 46 Command Description 46 ...

Page 6: ...Contents 6 Chapter 14 Reserve 16h 49 Command Description 49 Chapter 15 Send Diagnostic 1Dh 52 Command Description 52 Chapter 16 SCSI Error Reporting 54 Sense Keys 54 Sense Codes and Qualifiers 55 ...

Page 7: ...ry Data Field Values 18 Mode Select 15h 20 Table 5 1 Mode Select Command 15h 20 Table 5 2 Mode Select Command Field Values 21 Mode Sense 1Ah 22 Table 6 1 Mode Sense Command 1Ah 22 Table 6 2 Mode Sense Command Field Values 23 Table 6 3 Parameter List Header Format 24 Table 6 4 Element Address Assignments Page 1Dh 25 Table 6 5 Transport Geometry Parameter Page 1Eh 26 Table 6 6 Device Capabilities Fi...

Page 8: ...o All Element Descriptors 38 Table 10 7 Medium Transport Element Descriptor Tape Picker 39 Table 10 8 Storage Element Descriptor Magazine Slots 40 Table 10 9 Data Transfer Element Descriptor Tape Drive 41 Table 10 10 Data Transfer Element Descriptor Fields 41 Test Unit Ready 00h 43 Table 11 1 Test Unit Ready Command 00h 43 Release 17h 44 Table 12 1 Release Command 17h 44 Table 12 2 Release Command...

Page 9: ...es 9 Send Diagnostic 1Dh 52 Table 15 1 Send Diagnostic Command 1Dh 52 Table 15 2 Send Diagnostic Command Field Values 53 SCSIError Reporting 54 Table 16 1 Sense Key Values 54 Table 16 2 Library SCSI Error Codes 55 ...

Page 10: ...ardware developers who implement SCSI communication with the Spectra 2K tape library The guide assumes knowledge of or access to SCSI 2 standards and SCSI terminology Scope The SCSI interface of the Spectra 2K library was designed according to the SCSI 2 standard as defined by ANSI in publication ANSI X3 131 1994 Small Computer System Interface 2 SCSI 2 Within the standard there are many areas in ...

Page 11: ...2 describes the installation and operation of the Spectra 2K library including troubleshooting information Spectra 2K Library Release Notes P N 90870784 provides last minute information about the Spectra 2K library Spectra Logic Contact Information Note All library documentation is available in electronic format United States Headquarters European Office Mailing Address Spectra Logic Corporation 1...

Page 12: ...nventions to highlight notes tips cautions and warnings Note Read Notes for additional information or suggestions about a topic or procedure Caution Read Cautions for ways to avoid damaging the library tape drives or other equipment Warning Read Warnings for ways to prevent personal injury ...

Page 13: ...atically performs and stores an element inventory upon power up as well as each time the library s front door is opened and closed Element status information is also updated when the tape picker moves media from one element to another If a cartridge is in Drive 2 when the library takes inventory its bar code cannot be scanned The library indicates this condition by setting an EXCEPT bit in the dri...

Page 14: ... had received the INITIALIZE ELEMENT STATUS 07H command ignoring any additional parameters supplied with this command See Chapter 2 Initialize Element Status 07h for more information on the command Range ElementAddress Number of Elements These fields are ignored Table 3 1 Initialize Element Status With Range Command E7h Byte Bit 7 6 5 4 3 2 1 0 00 Operation code E7h 01 Logical Unit Number 0h Reser...

Page 15: ...parameters to the initiator The table below shows the CDB for the INQUIRY command Values and meanings of field names in bold are further described in Table 4 2 Table4 1 Inquiry Command 12h Byte Bit 0 1 2 3 4 5 6 7 00 Operation code 12h 01 Logical UnitNumber Reserved EVPD 02 Page Code 03 Reserved 04 Allocation Length 05 0 0 Reserved 0 0 ...

Page 16: ...thestandardinquiry datapage The Page Code fieldis then ignored The library does not supportany Vital Product Data pages Allocation Length 04 All 00 FFh Specifies the number of bytes the initiator allocates for data returned from the inquiry command Zero indicates no inquiry data is to be transferred this condition is notconsidered an error The library terminates the data in phase when ittransfers ...

Page 17: ...2h 17 08 15 MSB Vendor Identification LSB 16 31 MSB Product Identification LSB 32 35 MSB ProductRevision Level LSB 36 37 MSB Patch Level LSB 38 54 Reserved 55 Vendor Specific BCPres Table 4 3 Standard Inquiry Data Format ...

Page 18: ...e library does notsupport this optional field ISO Version 02 7 6 0h The library supports the current ANSI version of the SCSI 2 standard ECMA Version 02 5 3 0h ANSI approved Version 02 2 0 2h AENC 03 7 0 The library does not supportasynchronous event notification TrmIOP 03 6 0 The library does not supportterminate I O process Response Data Format 03 3 0 2h INQUIRY data returned by the library conf...

Page 19: ...2K libraries Product Revision Level 32 35 All Variablea These bytes are the ASCIIrepresentation of the currentproduct revision level with space 20h characters to fill four bytes For example 2 00 Patch Level 36 37 All Variablea Vendor specific field indicating the patch level of the firmware a Thevendor identification product identification product revision level and patch leveldatafields all retur...

Page 20: ...ed the library generates a UNIT ATTENTION to all initiators except the one that issued the MODESELECT command with sense information to indicate that mode parameters have changed Note Before issuing any MODE SELECT command issue a MODE SENSE command with the Page Code field set to 3Fh so the library returns all mode pages and the Page Control field set to 01h so the library indicates which fields ...

Page 21: ...s addresses Element addresses must be between 0 and 65 535 Table 5 2 Mode Select Command Field Values Field Name Field Location Values Allowed Meaning Byte Bit PF 01 4 1 The library supports the page format definedby the SCSI 2 standard SP Save Pages 01 0 0 Mode pages are not saved Mode parameter changes requestedin the parameter list are still made 1 All mode pages are saved whether they are chan...

Page 22: ...for the library These pages are described in detail below The initiator can change some of these parameters using the MODE SELECT command The SCSI 2 standard provides both a 6 byte and a 10 byte MODESENSE command The library uses the 6 byte command The table below shows the CDB for the MODESENSE command Values and meanings of field names are further described in Table 6 2 Table6 1 Mode Sense Comma...

Page 23: ...he requestedmode pages are returned but rather than parameter values bits are set to 1 if changeable or 0 if not 2h Requests default values 3h Requestssavedvalues Ifa pagehasnotbeensaved defaultvalues are returned Page Code 02 5 0 3Fh Requests the library return all available mode pages 1Dh Requests element address assignmentpage only 1Eh Requests transport geometry parameters page only 1Fh Reques...

Page 24: ...ode Data Length byte 00 indicates the number of bytes of parameter information available to the initiator not including the Mode Data Length byte itself For example if all mode pages are requested this value is 35h 53 one byte less than the total mode parameter length available Table6 3 Parameter List Header Format Byte Bit 0 1 2 3 4 5 6 7 00 Mode Data Length 01 03 Reservedfor other device types ...

Page 25: ...gth following this byte 02 MSB Medium Transport ElementAddress 03 LSB 04 MSB Number of MediumTransport Elements 01h for all Spectra 2K libraries 05 LSB 06 MSB First Storage ElementAddress 07 LSB 08 MSB Number of Storage Elements 0Fh 15 slots or 1Eh 30 slots 09 LSB 10 MSB First Import Export Element Address does not apply to the library 11 LSB 12 MSB Number of Import ExportElements does not apply t...

Page 26: ...SELECT command Transport Geometry Parameters For the library the transport geometry parameter page identifies that the tape picker does not rotate media Note These values cannot be modified with the MODESELECT command The Rotate byte 00 bit 0 value of 0 indicates that the tape picker cannot rotate or invert media The library uses only one sided media Table6 5 Transport Geometry Parameter Page 1Eh ...

Page 27: ...s Fields Format 1Fh Byte Bit 0 1 2 3 4 5 6 7 00 PS 1 Reserved Page Code 1Fh 01 Parameter Length 0Eh 02 Reserved StorDT 1 StorI E 0 StorST 1 StorMT 1 03 Reserved 04 Reserved MT DT 1 MT IE 0 MT ST 1 MT MT 0 05 Reserved ST DT 1 ST I E 0 ST ST 1 ST MT 1 06 Reserved I E DT 0 I E I E 0 I E ST 0 I E MT 0 07 Reserved DT DT 1 DT I E 0 DT ST 1 DT MT 1 08 11 Reserved 12 Reserved MT DT 0 MT IE 0 MT ST 0 MT MT...

Page 28: ...ses tape drives The 0 in the MT MT bit indicates that media cannot be moved from one medium transport element to another medium transport element this is because there is only one medium transport element Vendor Specific Parameters The library has vendor specific parameters that report and control the functions of the bar code reader This mode page is reported last The ChkSum byte 02 bit 1 bit ind...

Page 29: ...he bar code scanner is enabled as follows 0 bar code reader is disabled 1 bar code reader is enabled This bit can also be set with the MODESELECT command Note Both of these options are enabled bits set to 1 by default if a bar code reader is installed in the Spectra 2K library ...

Page 30: ... a READ ELEMENT STATUS command to the Spectra 2K library to find out current element addresses and which elements contain media The table below shows the CDB for the MOVEMEDIUM command Values and meanings of field names in bold are further described in Table 7 2 Table7 1 Move Medium Command A5h Byte Bit 0 1 2 3 4 5 6 7 00 Operation code A5h 01 Logical UnitNumber 0h Reserved 02 MSB Transport Elemen...

Page 31: ...ridgewillbe moved Invert 10 0 0 The Spectra 2K library does not supportthe invertfunction Clean 11 6 0 or 1 Avalueof1inthisvendor definedfieldsignalsthatthismoveis for cleaninga tape drive andthe Spectra 2K library shouldreturn the cleaning cartridge to its source slot when cleaning is complete a Permitted values for the Transport Element Source and Destination Addresses can be changed with the MO...

Page 32: ...other media changer devices an illegal command is not returned by the library if the host software issues this command but no robotic motion occurs The table below shows the CDB for the POSITION TO ELEMENT command Note The library does not move its tape picker in response to this command Table8 1 Position To Element Command 2Bh Bit Byte 7 6 5 4 3 2 1 0 00 Operation code 2Bh 01 Logical UnitNumber 0...

Page 33: ...ed no software method is available to prevent media from being removed from the library You may physically lock the library door with a key to prevent media from being removed The table below shows the CDB for the PREVENT ALLOW MEDIUM REMOVAL command The Prevent bit may be set to either 0 or 1 The library accepts both values even though the command has no effect Table 9 1 Prevent Allow Medium Remo...

Page 34: ...pt bit in returned data the library also supplies sense information to indicate the nature of the abnormal state This command asks the library to return the data stored in response to the INITIALIZE ELEMENTSTATUS command The table below shows the CDB for the READ ELEMENT STATUS command Values and meanings of field names in bold are further described in Table 10 2 Table 10 1 Read Element Status Com...

Page 35: ...formation Element Type Code 01 3 0 0h Return status for all element types Note thatthe library does not have an import export element 1h Return status only for medium transport elements tape picker 2h Returnstatus onlyfor storage elements cartridge magazine slots 4h Return status only for data transfer elements tape drives Starting Element Address 02 03 All Any The library only reports the status ...

Page 36: ...B FIrst ElementAddress Reported 01 LSB 02 MSB Number of Elements Reported 03 LSB 04 Reserved 05 MSB Byte count of all ElementStatus Pages does not include this header 06 07 LSB Table10 4 Element Status Page Format Byte Bit 0 1 2 3 4 5 6 7 00 ElementType Code 01 PVolTag AVolTag Reserved 02 MSB ElementDescriptor Length 03 LSB 04 Reserved 05 MSB Byte Countof Descriptor Data Available This Element Sta...

Page 37: ...yte Bit Element Type Code 00 3 0 01h Descriptors in this page are for medium transport elements tape picker 02h Descriptors in this page are for storage elements cartridge slots 04h Descriptors in this page are for data transfer elements tape drives PVolTag 01 7 0 bar code information primary volume tag is omittedfrom the descriptors 1 bar code information primary volume tag is included in the des...

Page 38: ...ense Code and Additional Sense Code Qualifierfields described below Full 1 bit A value of 1 indicates that the specifiedelementcontains media A value of 0 indicates thatthe elementdoes not contain media Additional Sense Code ASC 1 byte The ASC and ASCQ together may provide more information aboutthe condition which causedtheExceptbittobe setto 1 Their meaninghereisthesameastheASC and ASCQ returnedt...

Page 39: ...e tape picker can access the slot at Table 10 7 Medium Transport Element Descriptor TapePicker Byte Bit 0 1 2 3 4 5 6 7 00 MSB ElementAddressa Default value 86 a These fields are described in Table 10 6 on page38 01 LSB 02 Reserved Excepta Reserved Fulla 03 Reserved 04 Additional Sense Codea 05 Additional Sense Code Qualifiera 06 08 Reserved 09 SValida 0 Inverta 0 Reserved 10 MSB Source Storage El...

Page 40: ...in the table immediately following Table 10 8 Storage Element Descriptor Magazine Slots Byte Bit 0 1 2 3 4 5 6 7 00 MSB ElementAddressa Defaultvalue 0 14 0 29 on 30 cartridge Spectra 2K libraries a Thesefields are described in Table 10 6on page 38 01 LSB 02 Reserved Access Excepta Reserved Fulla 03 Reserved 04 Additional Sense Codea 05 Additional Sense Code Qualifiera 06 08 Reserved 09 SValida 0 I...

Page 41: ...dressa 11 LSB 12 47 MSB Primary Volume Tag Informationa Field omitted if PVolTag 0 LSB 48 51 Device Identifier 52 61 Identifier a These fields are described in Table10 6 on page38 Table 10 10 Data Transfer Element Descriptor Fields Field Name FieldLocation Value Returned Meaning Byte Bit Access 02 3 0 Access to thetape drive by thetape picker is denied This mightbe because the drive is in use or b...

Page 42: ...hetapedrive sLUNonitsownSCSIbus location The library does nottrack this value SCSI Bus Address 07 All Depends The library reports the SCSI ID number for the tape drive at this elementaddress This number canbe setwithaswitchon theback of the library Table 10 10 Data Transfer Element Descriptor Fields Field Name FieldLocation Value Returned Meaning Byte Bit ...

Page 43: ...UNITREADY command This command returns a GOOD status if the library is ready to accept a command This command returns CHECKCONDITION status with UNITATTENTION 6h in the sense key after power up and after a power on reset or a check condition with appropriate sense key for the error conditions This explains why a motion command may not be executed Table11 1 Test Unit Ready Command 00h Byte Bit 0 1 ...

Page 44: ...r attempts to release a reserved library or its elements the library returns a reservation conflict status Releasing an unreserved library or unreserved library elements is not an error The table below shows the CDB for the RELEASE command Values and meanings of field names in bold are further described in Table 12 2 Table 12 1 Release Command 17h Byte Bit 0 1 2 3 4 5 6 7 00 Operation code 17h 01 ...

Page 45: ...ibrary or some of its elements were previously reserved Ignored if the 3rdPty bitis 0 Element 01 0 0 The library shall release all active reservations for the entire unitor any of its elements which came from this initiator or were for the third party device specified if the 3rdPty bit is 1 1 The library shall release all elements reserved for this initiator with the matching ReservationID see the...

Page 46: ...2 bytes the library sends 52 if it is less the library truncates the sense data at the given allocation length The sense data is valid for the CHECK CONDITION status just presented to the initiator This sense data is preserved in the library for the initiator receiving the CHECKCONDITION status Sense data is cleared when any subsequent command that is not a request sense or an inquiry 12h command ...

Page 47: ...d 1 Errorcode 70h 01 Segment Number 00h not used by library 02 Reservedfor other device types Sense Key 03 MSB Information notused by the library 06 LSB 07 Additional Sense Length 08 MSB Command Specific Information 00h notused 11 LSB 12 Additional Sense Code ASC 13 Additional Sense Code Qualifier ASCQ 14 Field Replaceable Unit Code 15 SKSV MSB Sense key Specific not used 17 LSB 18 51 ASCII Repres...

Page 48: ...ay have been reset 9h Vendor Unique Sense information is specific to the library The Additional Sense Code and Additional Sense Code Qualifier provide details Additional Sense Length 07 All 2Dh Indicates that 45 bytes 2Dh of sense data follow this byte 52 total Additional Sense Code ASC 12 All Varies Provide further information aboutthe nature of the error condition beyond that reported in the Sen...

Page 49: ...revious reservation by the same initiator If the superseding reservation does not result in any reservation conflicts or error conditions the new reservations are completed and the previous reservation released The table below shows the CDB for the RESERVE command Values and meanings of field names in bold are further described in Table 14 2 Table14 1 Reserve Command 16h Bit Byte 7 6 5 4 3 2 1 0 0...

Page 50: ...ervedby another initiator thelibrary rejects this commandwith a RESERVATION CONFLICT message 1 Requests reservation of specific element addresses in the library The elements mustbe specified by an element listimmediately following the commandblock The formatof the element listis described below Reservation ID 02 All Assigned by initiator This fieldis only checkedif the Element bitis 1 Different el...

Page 51: ...ero the library attempts to reserve all elements at or above the Starting Element Address Contiguous element addresses can therefore be reserved with a single Element List Descriptor by setting Number of Elements to any value except 1 Non contiguous elements can be reserved with a single Reservation ID by sending multiple Descriptors in a single Element List Table 14 3 Element List Descriptor Form...

Page 52: ...ification replying only with GOOD or CHECK CONDITION status The library does not support the SCSI RECEIVE DIAGNOSTIC RESULTS command The table below shows the CDB for the SEND DIAGNOSTIC command Values and meanings of field names in bold are further described in Table 15 2 Table15 1 Send Diagnostic Command 1Dh Byte Bit 0 1 2 3 4 5 6 7 00 Operation code 1Dh 01 Logical UnitNumber 0h PF Reserved Self...

Page 53: ...ocation Values Allowed Meaning Byte Bit PF Page Format 01 4 1 Indicates thatthe command parameters conform to the SCSI 2 standard SelfTest 01 2 1 Directs the library to perform its default self test This is the only diagnostic option available through theSEND DIAGNOSTICcommand DevOfL Device off line 01 1 1 Permits the library to make itself unavailable while testing The library must be allowedto d...

Page 54: ...scribes the Sense Key valuations returned by the library The Sense Key indicates very generally what the nature of the error condition is Table16 1 SenseKey Values Sense Key Meaning Explanation 0h No Sense There is no specific sense key information 2h NotReady Library cannot be accessed Operator intervention may be required to correct this condition See the additional sense code description for mo...

Page 55: ...es the most complete error description available from the library The following table describes the error codes returned by the library Table 16 2 Library SCSI Error Codes Sense Key ASC ASCQ ErrorDescription Error RemedyorExplanation 0h 00h 00h Unit Ready No problems no additional sense information 2h Not ready 04h 00h UnitNot Ready The unit is notyet ready to accept commands 04h 01h Unit is Becom...

Page 56: ...Bad FPROM or invalid device in socket Contact Spectra Logic Support 87h 01h FPROM Erase Operation Failed Contact Spectra Logic Support 87h 02h FPROM Write Operation Failed Contact Spectra Logic Support 85h 01h Robot Not Initialized Contact Spectra Logic Support 85h 99h Generic Robotics Error Contact Spectra Logic Support 85h 02h Long Axis Robotics Error Contact Spectra Logic Support 85h 03h ShortA...

Page 57: ...is full or there is an inventory sensor problem 3Bh 0Eh MediumSourceElement Empty The source element is empty or there is an inventory sensor problem 3Dh 00h Identify Message Error The identify message hadinvalidbits set in a SCSI message 3Dh 80h Disconnects Must Be Allowed The hostmustallow SCSI disconnects for commands to complete 80h 18h Conflict Element is Reserved Re issue commandafter the re...

Page 58: ...e error for the elementdescriptors the ASC ASCQ 84h 00h Unsupported SCSI Command Serial SCSIcommanderror contact Spectra Logic Support 84h 01h No Response from SCSI Target SCSI targetfailedto respond checkSCSI bus connections and device power 84h 02h Check Condition from Target Serial SCSI command failed read SCSI sense data to determine the cause of checkcondition 84h 03h SCSIIDSameasLibrary s ID...

Page 59: ...ransfer elements 40 default address 41 descriptor format 41 default address data transfer elements 41 magazine slots 40 medium transport element 39 robotic picker 39 storage elements 40 tape drives 41 descriptor formats data transfer element 41 element list 51 tape drives 41 diagnostics 52 drives see tape drives E element list descriptors 51 elements data transfer 40 releasing 44 reserving 49 erro...

Page 60: ...N TO ELEMENT command 32 PREVENT ALLOW MEDIUM REMOVAL command 33 Q qualifiers sense code 55 R READ ELEMENT STATUS command 13 RECEIVE DIAGNOSTIC RESULTS command 52 RELEASE command 44 releasing reservations 44 REQUEST SENSE command 46 54 RESERVE command 49 reserving devices 49 reserving elements 49 robotic picker default element address 39 S SCSI commands INITIALIZE ELEMENT STATUS 13 INQUIRY 15 MODE ...

Page 61: ...s 11 fax 11 mailing addresses 11 main offices 11 phone 11 Web site 11 status CHECK CONDITION 43 GOOD 43 UNIT ATTENTION 20 storage elements default address 40 descriptor format 40 T tape drives 40 default element address 41 descriptor format 41 TEST UNIT READY command 43 tests diagnostics 52 U unit attention sense key 54 57 UNIT ATTENTION status 20 V vendor identification 19 vendor specific sense k...

Reviews:

No comments