1. Manuals
  2. Brands
  3. Spectra Logic Manuals
  4. Storage
  5. Spectra 2k
  6. Develop manual

Spectra Logic Spectra 2k Develop Manual

Library
Hide thumbs Also See for Spectra 2k:
Table of Contents

Advertisement

Quick Links

Download this manual See also: User Manual, Read This First
™
Spectra 2K
Library
Developer Guide
P.N. 90870750 Revision C

Advertisement

Table of Contents
loading

Related Manuals for Spectra Logic Spectra 2k

Summary of Contents for Spectra Logic Spectra 2k

  • Page 1 ™ Spectra 2K Library Developer Guide P.N. 90870750 Revision C...
  • Page 2 In no event shall Spectra Logic be liable for any loss of profits, loss of business, loss of use of data, interruption 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.
  • Page 3 Software is licensed, not sold. If you do not agree to this End User License Agreement (EULA), do not use the Spectra Logic product. Instead, promptly contact Spectra Logic for instruction on return of the product for a refund. Any use of the Software, including but not limited to use of the product, will constitute your agreement to this EULA (or ratification of any previous consent).

  • Page 4: Table Of Contents

    Spectra Logic Contact Information ........
  • Page 5 Chapter 7. Move Medium—A5h Command Description ..........30 Chapter 8.
  • Page 6 Chapter 14. Reserve—16h Command Description ..........49 Chapter 15.
  • Page 7 List of Tables Initialize Element Status—07h Table 2-1: Initialize Element Status Command—07h ..... . . 13 Initialize Element Status With Range—E7h Table 3-1: Initialize Element Status With Range Command—E7h .
  • Page 8 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) .
  • Page 9 Send Diagnostic—1Dh Table 15-1: Send Diagnostic Command—1Dh ......52 Table 15-2: Send Diagnostic Command Field Values ..... . . 53 SCSI Error Reporting Table 16-1: Sense Key Values .

  • Page 10: Chapter 1. Introduction

    This guide describes the implementation of the SCSI bus communication for the Spectra 2K library. This robotic tape library can store up to 30 tapes within the library, and it uses a robotic tape picker to move tapes from storage to a tape drive. Sensors track the location of data cartridges within the library, and a bar code reader, if installed, reads and stores bar code label information on the cartridges.

  • Page 11: Contents Of This Guide

    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.

  • Page 12: Conventions Used In This Guide

    Conventions Used in this Guide This guide uses the following conventions to highlight notes, tips, cautions, and warnings: Note: Notes Read for additional information or suggestions about a topic or procedure. Caution: Cautions Read or other equipment. Warning: Warnings Read Chapter 1.

  • Page 13: Chapter 2. Initialize Element Status-07H

    2 Initialize Element Status—07h Command Description The INITIALIZE ELEMENT STATUS command instructs the library to take an inventory if its elements. The library does this by moving the tape picker across the front of the data cartridge magazine. The tape picker houses an inventory sensor, which collects element status information.

  • Page 14: Chapter 3. Initialize Element Status With Range-E7H

    3 Initialize Element Status With Range—E7h Command Description INITIALIZE ELEMENT STATUS WITH RANGE is a vendor-specific command for Exabyte tape libraries. It is included in the library’s command set to support the library’s emulation of Exabyte libraries. When the library receives this command, it performs as though it had received the INITIALIZE ELEMENT STATUS (07H) command, ignoring any additional parameters supplied with this command.

  • Page 15: Chapter 4. Inquiry-12H

    4 Inquiry—12h Command Description The INQUIRY command instructs the library to send information regarding its 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. Table 4-1: Inquiry Command—12h Byte Logical Unit Number...

  • Page 16: Table 4-2: Inquiry Command Field Values

    Table 4-2: Inquiry Command Field Values Field Location Field Name Byte Logical Unit Number EVPD (Enable Vital Product Data) Allocation Length If the EVPD bit in the INQUIRY command is 0, the library returns standard INQUIRY data, as show in Table 4-3. Values and meanings of field names in bold are further described in Table 4-4.
  • Page 17 Table 4-3: Standard Inquiry Data Format (MSB) 08 - 15 (MSB) 16 - 31 (MSB) 32 - 35 (MSB) 36 - 37 38-54 Chapter 4. Inquiry—12h Vendor Identification Product Identification Product Revision Level Patch Level Reserved Vendor Specific (LSB) (LSB) (LSB) (LSB) BCPres...

  • Page 18: Table 4-4: Standard Inquiry Data Field Values

    Table 4-4: Standard Inquiry Data Field Values Field Location Field Name Byte Peripheral Qualifier Peripheral Device Type Device Type Modifier ISO Version ECMA Version ANSI-approved Version AENC TrmIOP Response Data Format Additional Length RelAdr WBus 32 WBus 16 Sync Linked CmdQue Chapter 4.
  • Page 19 These bytes are the ASCII representation of “SPECTRA” (uppercase) SPECTRA followed by a space (20h). This is the product identification returned by all Spectra 2K These bytes are the ASCII representation of the current product Variable revision level, with space (20h) characters to fill four bytes. For Variable Vendor-specific field, indicating the patch level of the firmware.

  • Page 20: Chapter 5. Mode Select-15H

    5 Mode Select—15h Command Description The MODE SELECT command allows the initiator to change device parameters of the library. An initiator uses these parameters to configure the library after power-up or a bus device reset message. Library parameters that can be set with MODE SELECT are element addresses, enabling or disabling the bar code reader, and enabling or disabling bar code checksum checking.

  • Page 21: Table 5-2: Mode Select Command Field Values

    Table 5-2: Mode Select Command Field Values Field Location Field Name Byte (Save Pages) Parameter List Length Mode Parameter Lists Following the command block, in the data out phase, the initiator sends a parameter list containing the new parameter values of the library. This parameter list has the same format as the data the library returns to a MODE SENSE command, with the restriction that only one type of mode page per command is allowed for MODE SELECT.

  • Page 22: Chapter 6. Mode Sense-1Ah

    6 Mode Sense—1Ah Command Description The MODE SENSE command asks the library to report its operating mode parameters to the initiator. The parameters are returned in mode pages. The library supports: • Element address assignments • Tape picker capabilities (transport geometry parameters) •...

  • Page 23: Table 6-2: Mode Sense Command Field Values

    Table 6-2: Mode Sense Command Field Values Field Location Field Name Byte (Disable Block Descriptors) Page Control Page Code Allocation Length If all mode pages are requested, the library returns 54 bytes of mode sense data to the initiator, structured as follows: •...

  • Page 24: Table 6-3: Parameter List Header Format

    Each of these items is described in the tables that follow. Note that if a specific page is requested, the library returns only the header data and the specific page. Table 6-3: Parameter List Header Format Byte 01 - 03 The Mode Data Length (byte 00) indicates the number of bytes of parameter information available to the initiator, not including the Mode Data Length byte itself.

  • Page 25: Table 6-4: Element Address Assignments Page-1Dh

    Page Code—1Dh Parameter List Length (following this byte) Medium Transport Element Address Number of Medium Transport Elements 01h for all Spectra 2K libraries First Storage Element Address Number of Storage Elements 0Fh (15 slots) or 1Eh (30 slots) First Import/Export Element Address...

  • Page 26: Table 6-5: Transport Geometry Parameter Page-1Eh

    RAM. This is done by setting the SP field in the MODE SELECT command. See MODE SELECT for details. Note: All of the Spectra 2K library’s mode parameter pages can be saved to nonvolatile RAM, although not all of the parameters can be changed with the MODE SELECT command.

  • Page 27: Table 6-6: Device Capabilities Fields Format-1Fh

    Device Capabilities The device capabilities mode page is described in the table below. Table 6-6: Device Capabilities Fields Format—1Fh Byte PS—1 Reserved Reserved Reserved Reserved Reserved Reserved 08-11 Reserved In the table above, the following abbreviations and definitions apply: DT Data transfer element (tape drive) IE Import/export element (the library has no import/export element) Chapter 6.

  • Page 28: Table 6-7: Vendor-Specific Parameters-00H

    ST Storage element (magazine slot) MT Medium transport element (tape picker) Stor A1 in a StorXX bit indicates media can be stored at elements of type XX; a 0 indicates it cannot. -> A 1 in a XX -> YY bit indicates that media can be moved from elements of type XX to elements of type YY.
  • Page 29 This bit can also be set with the MODE SELECT 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. Chapter 6. Mode Sense—1Ah...

  • Page 30: Chapter 7. Move Medium-A5H

    The MODE SENSE data contains a matrix with the valid element source-destination combinations for the MOVE MEDIUM command, described on page 22. Send a READ ELEMENT STATUS command to the Spectra 2K library to find out current element addresses and which elements contain media.

  • Page 31: Table 7-2: Move Medium Command Field Values

    A value of 1 in this vendor-defined field signals that this move is for 0 or 1 cleaning a tape drive, and the Spectra 2K library should return the cleaning cartridge to its source slot when cleaning is complete. cartridge is.

  • Page 32: Chapter 8. Position To Element-2Bh

    8 Position To Element—2Bh Command Description The POSITION TO ELEMENT command requests the tape picker to position itself at a specific element address. No movement occurs for a POSITION TO ELEMENT command. This command does not significantly reduce the access time for loading or unloading a tape drive. This command is included for compatibility with other media changer devices;...

  • Page 33: Chapter 9. Prevent/Allow Medium Removal-1Eh

    9 Prevent/Allow Medium Removal—1Eh Command Description The PREVENT/ALLOW MEDIUM REMOVAL command determines whether the library permits the removal of data cartridges. The library accepts this command, but does nothing in response. Note: The library accepts this command, but does nothing. Because the door to the library can be opened and the media removed, no software method is available to prevent media from being removed from the library.

  • Page 34: Chapter 10. Read Element Status-B8H

    10 Read Element Status—B8h Command Description The READ ELEMENT STATUS command requests that the library return the status of the elements in the library. An element’s status includes its element address, element type, whether it contains media, and whether it is in an abnormal state. If the library has a bar code reader and the VolTag command option is set, media bar code information is also returned.

  • Page 35: Table 10-2: Read Element Status Command Field Values

    Return status only for medium transport elements (tape picker). Return status only for storage elements (cartridge magazine slots). Return status only for data transfer elements (tape drives). The library only reports the status of elements at or above this Starting Element Address, and of the type specified by the Element The library does not return device identifiers.

  • Page 36: Table 10-3: Element Status Data Header Format

    Table 10-3: Element Status Data Header Format Byte (MSB) (MSB) (MSB) The Element Status Data Header is followed immediately by Element Status Pages for each element type reported. Each Element Status Page consists of a header followed by Element Descriptors for each element reported. Table 10-4: Element Status Page Format Byte PVolTag...

  • Page 37: Element Descriptors

    Meaning Descriptors in this page are for medium transport elements (tape picker) Descriptors in this page are for storage elements (cartridge slots) Descriptors in this page are for data transfer elements (tape drives) bar code information (primary volume tag) is omitted from the descriptors.

  • Page 38: Table 10-6: Fields Common To All Element Descriptors

    Meaning The address used to identify the particular element, i.e., tape picker, cartridge storage slots, or tape drive. Each element in the library must have a unique address. Element addresses are used by almost all medium changer device type-specific SCSI commands to identify locations applicable to the particular command.

  • Page 39: Table 10-7: Medium Transport Element Descriptor (Tape Picker)

    These fields are described in Table 10-6 on page 38. Cartridge Slots—Storage Elements The slots in the library’s data cartridge magazine are the storage elements. In the table below, the Access bit (byte 02, bit 3) is set to 1 if the tape picker can access the slot at Chapter 10.

  • Page 40: Table 10-8: Storage Element Descriptor (Magazine Slots)

    CTS; the library can have up to two CTSs. Terms in bold in the table below are defined in the table immediately following. Chapter 10. Read Element Status—B8h Element Address Default value=0-14 (0-29 on 30-cartridge Spectra 2K libraries) Reserved Access Reserved...

  • Page 41: Table 10-9: Data Transfer Element Descriptor (Tape Drive)

    Additional Sense Code Additional Sense Code Qualifier ID Valid LU Valid Reserved SCSI Bus Address Reserved Reserved Source Storage Element Address Primary Volume Tag Information (Field omitted if PVolTag=0) Device Identifier Identifier Value Meaning Returned Access to the tape drive by the tape picker is denied. This might be because the drive is in use or because it is not installed.
  • Page 42 Table 10-10: Data Transfer Element Descriptor Fields Field Location Field Name Byte LU Valid Logical Unit Number SCSI Bus Address Chapter 10. Read Element Status—B8h Value Meaning Returned The value in Logical Unit Number is not valid. This field is not valid. This is the tape drive’s LUN on its own SCSI bus location.

  • Page 43: Chapter 11. Test Unit Ready-00H

    11 Test Unit Ready—00h Command Description The TEST UNIT READY command determines if the library is on and ready to accept commands. This command is not a request for a library self-test. The library performs a self-test during power-on or in response to a SEND DIAGNOSTIC command. The table below shows the CDB for the TEST UNIT READY command.

  • Page 44: Chapter 12. Release-17H

    12 Release—17h Command Description The RELEASE command enables the initiator to release reservations on the library or library elements that were set by the RESERVE (16h) command. See page 49 for more information. Only the initiator that reserved the library or its elements can release them. If another initiator attempts to release a reserved library or its elements, the library returns a reservation conflict status.

  • Page 45: Table 12-2: Release Command Field Values

    Table 12-2: Release Command Field Values Field Location Values Field Name Allowed Byte 3rdPty Third Party Device ID Element Reservation Chapter 12. Release—17h Meaning Release is not being requested for a third-party reservation. Release is being requested for a reservation made previously by this initiator for the third-party device identified in the Third Party Device ID.

  • Page 46: Chapter 13. Request Sense-03H

    13 Request Sense—03h Command Description The REQUEST SENSE command requests the library to send sense data to the initiator. It is generally issued immediately after the library reports a CHECK CONDITION status for the previous command. The table below shows the CDB for the REQUEST SENSE command. Table 13-1: Request Sense Command—03h Byte Logical Unit Number—0h...

  • Page 47: Table 13-2: Sense Data Format

    The table below shows the format of the sense data returned by the library. Terms in bold are further explained in Table 13-3. Table 13-2: Sense Data Format Byte Valid— Reserved for other device types 03 - (MSB) 08 - (MSB) SKSV (MSB)

  • Page 48: Table 13-3: Sense Data Fields

    Table 13-3: Sense Data Fields Field Location Field Name Byte Valid Error Code Sense Key General Error Category (See Chapter 16. SCSI Error Reporting for more information.) Additional Sense Length Additional Sense Code (ASC) Additional Sense Code Qualifier (ASCQ) Field Replaceable Unit Code SKSV...

  • Page 49: Chapter 14. Reserve—16H

    14 Reserve—16h Command Description The RESERVE command allows the initiator to reserve the library or its elements. The elements reserved are released as a result of a RELEASE (17h) command from the same initiator, a bus device reset condition, a SCSI bus reset, or a power-on cycle of the library.

  • Page 50: Table 14-2: Reserve Command Field Values

    Table 14-2: Reserve Command Field Values Field Location Field Name Byte 3rdPty Third Party Device ID Element Reservation ID Element List 03-04 Length Chapter 14. Reserve—16h Values Meaning Allowed Indicates that a third party reservation is not requested. Indicates that a third party reservation is requested. If the RESERVE command succeeds, the library or its specified elements are reserved for the third-party device identified by the Third Party The SCSI ID number of the third party device for which the...

  • Page 51: Table 14-3: Element List Descriptor Format

    Element List If the initiator requests a reservation for specific elements within the library, it must specify the elements in a list of one or more Element List Descriptors. The data format for these descriptors is shown in the table below. Table 14-3: Element List Descriptor Format Byte Note:...

  • Page 52: Command Description

    15 Send Diagnostic—1Dh Command Description The SEND DIAGNOSTIC command requests that the library perform diagnostic tests on itself. The library disconnects from the SCSI bus during the performance of its diagnostic tests. The library supports the SEND DIAGNOSTIC command minimum specification, replying only with GOOD or CHECK CONDITION status.

  • Page 53: Table 15-2: Send Diagnostic Command Field Values

    Table 15-2: Send Diagnostic Command Field Values Field Location Values Field Name Allowed Byte Page Format SelfTest DevOfL Device off- line UnitOfL Unit off-line Parameter 03-04 List Length The library does not return any data to the SEND DIAGNOSTIC command. If its self-test completes successfully, the library returns a GOOD status.

  • Page 54: Chapter 16. Scsi Error Reporting

    16 SCSI Error Reporting This section lists the error codes and corresponding meanings that can be returned by the library. Refer to the tape drive manual for the error codes returned by the tape drive. SCSI devices report errors by returning the CHECK CONDITION status after trying to execute a command received from an initiator.

  • Page 55: Sense Codes And Qualifiers

    The following sense keys are not used by the library: • 1h—Recovered error • 3h—Medium error • 7h—Data protect • 8h—Blank check • Ah—Copy aborted • Bh—Aborted command • Ch—Equal • Dh—Volume overflow • Eh—Miscompare Sense Codes and Qualifiers Combining the Sense Key with the Additional Sense Code (ASC) and Additional Sense Code Qualifier (ASCQ) returned to a REQUEST SENSE command gives the most complete error description available from the library.
  • Page 56 Chapter 16. SCSI Error Reporting Error Description Error Remedy or Explanation Unit Failed Initialization Contact Spectra Logic Support. DRAM Memory Failure Contact Spectra Logic Support. Two or More SCSI IDs in Use SCSI ID switches to assign unique numbers to the library are the same Tape may be broken;...
  • Page 57 Table 16-2: Library SCSI Error Codes Sense Key ASCQ Illegal request Unit attention Chapter 16. SCSI Error Reporting Error Description Error Remedy or Explanation Parameter List Length The number of SCSI mode parameters passed Error differs from the number required. The SCSI or serial command code received was not Invalid Command Code a valid command for the library.
  • Page 58 Table 16-2: Library SCSI Error Codes Sense Key ASCQ Vendor- specific Note: To access the most complete and current listing of Spectra 2K library sense code information, use Spectra Logic’s interactive Sense Code Lookup tool at: http://www.spectralogic.com/ index.cfm?fuseaction=support.senseCodeForm&catID=247 Chapter 16. SCSI Error Reporting Error Description...
  • Page 59 41 Index 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...
  • Page 60 identification product 19 vendor 19 illegal request sense key 54, 57 INITIALIZE ELEMENT STATUS command 13, 34 INQUIRY command 15 magazine slots default element address 40 medium transport element default address 39 descriptor format 39 mode parameters reading 22 saving and reloading 20, 26 setting 20 MODE SELECT command 20 MODE SENSE command 22...
  • Page 61 41 descriptor format 41 TEST UNIT READY command 43 tests diagnostics 52 unit attention sense key 54, 57 Index UNIT ATTENTION status 20 vendor identification 19 vendor specific sense key 54, 58 Web site Spectra Logic 11...

Table of Contents