/* $FreeBSD$ */ /* $NetBSD: scsi_changer.h,v 1.11 1998/02/13 08:28:32 enami Exp $ */ /*- * SPDX-License-Identifier: BSD-4-Clause * * Copyright (c) 1996 Jason R. Thorpe * All rights reserved. * * Partially based on an autochanger driver written by Stefan Grefen * and on an autochanger driver written by the Systems Programming Group * at the University of Utah Computer Science Department. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the distribution. * 3. All advertising materials mentioning features or use of this software * must display the following acknowledgements: * This product includes software developed by Jason R. Thorpe * for And Communications, http://www.and.com/ * 4. The name of the author may not be used to endorse or promote products * derived from this software without specific prior written permission. * * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF * SUCH DAMAGE. */ /* * SCSI changer interface description */ /*- * Partially derived from software written by Stefan Grefen * (grefen@goofy.zdv.uni-mainz.de soon grefen@convex.com) * based on the SCSI System by written Julian Elischer (julian@tfs.com) * for TRW Financial Systems. * * TRW Financial Systems, in accordance with their agreement with Carnegie * Mellon University, makes this software available to CMU to distribute * or use in any manner that they see fit as long as this message is kept with * the software. For this reason TFS also grants any other persons or * organisations permission to use or modify this software. * * TFS supplies this software to be publicly redistributed * on the understanding that TFS is not responsible for the correct * functioning of this software in any circumstances. * * Ported to run under 386BSD by Julian Elischer (julian@tfs.com) Sept 1992 */ #ifndef _SCSI_SCSI_CH_H #define _SCSI_SCSI_CH_H 1 #include /* * SCSI command format */ /* * Exchange the medium in the source element with the medium * located at the destination element. */ struct scsi_exchange_medium { uint8_t opcode; #define EXCHANGE_MEDIUM 0xa6 uint8_t byte2; uint8_t tea[2]; /* transport element address */ uint8_t src[2]; /* source address */ uint8_t fdst[2]; /* first destination address */ uint8_t sdst[2]; /* second destination address */ uint8_t invert; #define EXCHANGE_MEDIUM_INV1 0x01 #define EXCHANGE_MEDIUM_INV2 0x02 uint8_t control; }; /* * Cause the medium changer to check all elements for medium and any * other status relevant to the element. */ struct scsi_initialize_element_status { uint8_t opcode; #define INITIALIZE_ELEMENT_STATUS 0x07 uint8_t byte2; uint8_t reserved[3]; uint8_t control; }; /* * Request the changer to move a unit of media from the source element * to the destination element. */ struct scsi_move_medium { uint8_t opcode; uint8_t byte2; uint8_t tea[2]; /* transport element address */ uint8_t src[2]; /* source element address */ uint8_t dst[2]; /* destination element address */ uint8_t reserved[2]; uint8_t invert; #define MOVE_MEDIUM_INVERT 0x01 uint8_t control; }; /* * Position the specified transport element (picker) in front of * the destination element specified. */ struct scsi_position_to_element { uint8_t opcode; uint8_t byte2; uint8_t tea[2]; /* transport element address */ uint8_t dst[2]; /* destination element address */ uint8_t reserved[2]; uint8_t invert; #define POSITION_TO_ELEMENT_INVERT 0x01 uint8_t control; }; /* * Request that the changer report the status of its internal elements. */ struct scsi_read_element_status { uint8_t opcode; uint8_t byte2; #define READ_ELEMENT_STATUS_VOLTAG 0x10 /* report volume tag info */ /* ...next 4 bits are an element type code... */ uint8_t sea[2]; /* starting element address */ uint8_t count[2]; /* number of elements */ uint8_t flags; #define READ_ELEMENT_STATUS_DVCID 0x01 /* report device serial number */ #define READ_ELEMENT_STATUS_CURDATA 0x02 /* allow motion during command */ uint8_t len[3]; /* length of data buffer */ uint8_t reserved1; uint8_t control; }; struct scsi_request_volume_element_address { uint8_t opcode; uint8_t byte2; #define REQUEST_VOLUME_ELEMENT_ADDRESS_VOLTAG 0x10 /* ...next 4 bits are an element type code... */ uint8_t eaddr[2]; /* element address */ uint8_t count[2]; /* number of elements */ uint8_t reserved0; uint8_t len[3]; /* length of data buffer */ uint8_t reserved1; uint8_t control; }; /* XXX scsi_release */ /* * Changer-specific mode page numbers. */ #define CH_ELEMENT_ADDR_ASSIGN_PAGE 0x1D #define CH_TRANS_GEOM_PARAMS_PAGE 0x1E #define CH_DEVICE_CAP_PAGE 0x1F /* * Data returned by READ ELEMENT STATUS consists of an 8-byte header * followed by one or more read_element_status_pages. */ struct read_element_status_header { uint8_t fear[2]; /* first element address reported */ uint8_t count[2]; /* number of elements available */ uint8_t reserved; uint8_t nbytes[3]; /* byte count of all pages */ }; struct read_element_status_page_header { uint8_t type; /* element type code; see type codes below */ uint8_t flags; #define READ_ELEMENT_STATUS_AVOLTAG 0x40 #define READ_ELEMENT_STATUS_PVOLTAG 0x80 uint8_t edl[2]; /* element descriptor length */ uint8_t reserved; uint8_t nbytes[3]; /* byte count of all descriptors */ }; /* * Format of a volume tag */ struct volume_tag { uint8_t vif[32]; /* volume identification field */ uint8_t reserved[2]; uint8_t vsn[2]; /* volume sequence number */ }; struct read_element_status_device_id { uint8_t prot_code_set; #define READ_ELEMENT_STATUS_CODE_SET(p) ((p) & 0x0F) #define READ_ELEMENT_STATUS_PROTOCOL_ID(p) ((p) >> 4) uint8_t piv_assoc_designator_type; #define READ_ELEMENT_STATUS_PIV_SET 0x80 #define READ_ELEMENT_STATUS_ASSOCIATION(p) ((p) >> 4) #define READ_ELEMENT_STATUS_DESIGNATOR_TYPE(p) ((p) & 0x0F) uint8_t reserved2; uint8_t designator_length; uint8_t designator[256]; /* Allocate max length */ }; struct read_element_status_descriptor { uint8_t eaddr[2]; /* element address */ uint8_t flags1; #define READ_ELEMENT_STATUS_FULL 0x01 #define READ_ELEMENT_STATUS_IMPEXP 0x02 #define READ_ELEMENT_STATUS_EXCEPT 0x04 #define READ_ELEMENT_STATUS_ACCESS 0x08 #define READ_ELEMENT_STATUS_EXENAB 0x10 #define READ_ELEMENT_STATUS_INENAB 0x20 #define READ_ELEMENT_STATUS_MT_MASK1 0x05 #define READ_ELEMENT_STATUS_ST_MASK1 0x0c #define READ_ELEMENT_STATUS_IE_MASK1 0x3f #define READ_ELEMENT_STATUS_DT_MASK1 0x0c uint8_t reserved0; uint8_t sense_code; uint8_t sense_qual; union { struct { uint8_t dt_scsi_flags; #define READ_ELEMENT_STATUS_DT_LUNMASK 0x07 #define READ_ELEMENT_STATUS_DT_LUVALID 0x10 #define READ_ELEMENT_STATUS_DT_IDVALID 0x20 #define READ_ELEMENT_STATUS_DT_NOTBUS 0x80 uint8_t dt_scsi_addr; uint8_t reserved1; } scsi_2; /* reserved and obsolete (as of SCSI-3) fields */ uint8_t reserved_or_obsolete[3]; } dt_or_obsolete; uint8_t flags2; #define READ_ELEMENT_STATUS_INVERT 0x40 #define READ_ELEMENT_STATUS_SVALID 0x80 #define READ_ELEMENT_STATUS_ED 0x80 #define READ_ELEMENT_STATUS_MEDIA_TYPE_MASK 0x07 uint8_t ssea[2]; /* source storage element address */ union { struct volume_tag pvoltag; struct volume_tag voltag[2]; struct read_element_status_device_id devid; struct { struct volume_tag pvoltag; struct read_element_status_device_id devid; } pvol_and_devid; struct { struct volume_tag voltag[2]; struct read_element_status_device_id devid; } vol_tags_and_devid; } voltag_devid; }; /* XXX add data returned by REQUEST VOLUME ELEMENT ADDRESS */ /* Element type codes */ #define ELEMENT_TYPE_MASK 0x0f /* Note: these aren't bits */ #define ELEMENT_TYPE_ALL 0x00 #define ELEMENT_TYPE_MT 0x01 #define ELEMENT_TYPE_ST 0x02 #define ELEMENT_TYPE_IE 0x03 #define ELEMENT_TYPE_DT 0x04 /* * XXX The following definitions should be common to all SCSI device types. */ #define PGCODE_MASK 0x3f /* valid page number bits in pg_code */ #define PGCODE_PS 0x80 /* indicates page is savable */ /* * Send volume tag information to the changer */ struct scsi_send_volume_tag { uint8_t opcode; #define SEND_VOLUME_TAG 0xb6 uint8_t byte2; uint8_t ea[2]; /* element address */ uint8_t reserved2; uint8_t sac; /* send action code */ #define SEND_VOLUME_TAG_ASSERT_PRIMARY 0x08 #define SEND_VOLUME_TAG_ASSERT_ALTERNATE 0x09 #define SEND_VOLUME_TAG_REPLACE_PRIMARY 0x0a #define SEND_VOLUME_TAG_REPLACE_ALTERNATE 0x0b #define SEND_VOLUME_TAG_UNDEFINED_PRIMARY 0x0c #define SEND_VOLUME_TAG_UNDEFINED_ALTERNATE 0x0d uint8_t reserved4[2]; uint8_t pll[2]; /* parameter list length */ uint8_t reserved5; uint8_t control; }; /* * Parameter format for SEND VOLUME TAG */ struct scsi_send_volume_tag_parameters { uint8_t vitf[32]; /* volume tag identification template */ uint8_t reserved1[2]; uint8_t minvsn[2]; /* minimum volume sequence number */ uint8_t reserved2[2]; uint8_t maxvsn[2]; /* maximum volume sequence number */ }; /* * Device capabilities page. * * This page defines characteristics of the element types in the * medium changer device. * * Note in the definitions below, the following abbreviations are * used: * MT Medium transport element (picker) * ST Storage transport element (slot) * IE Import/export element (portal) * DT Data transfer element (tape/disk drive) */ struct page_device_capabilities { uint8_t pg_code; /* page code (0x1f) */ uint8_t pg_length; /* page length (0x12) */ /* * The STOR_xx bits indicate that an element of a given * type may provide independent storage for a unit of * media. The top four bits of this value are reserved. */ uint8_t stor; #define STOR_MT 0x01 #define STOR_ST 0x02 #define STOR_IE 0x04 #define STOR_DT 0x08 uint8_t reserved0; /* * The MOVE_TO_yy bits indicate the changer supports * moving a unit of medium from an element of a given type to an * element of type yy. This is used to determine if a given * MOVE MEDIUM command is legal. The top four bits of each * of these values are reserved. */ uint8_t move_from[CHET_MAX + 1]; #define MOVE_TO_MT 0x01 #define MOVE_TO_ST 0x02 #define MOVE_TO_IE 0x04 #define MOVE_TO_DT 0x08 uint8_t reserved1[4]; /* * Similar to above, but for EXCHANGE MEDIUM. */ uint8_t exchange_with[CHET_MAX + 1]; #define EXCHANGE_WITH_MT 0x01 #define EXCHANGE_WITH_ST 0x02 #define EXCHANGE_WITH_IE 0x04 #define EXCHANGE_WITH_DT 0x08 }; /* * Medium changer elemement address assignment page. * * Some of these fields can be a little confusing, so an explanation * is in order. * * Each component within a medium changer apparatus is called an * "element". * * The "medium transport element address" is the address of the first * picker (robotic arm). "Number of medium transport elements" tells * us how many pickers exist in the changer. * * The "first storage element address" is the address of the first * slot in the tape or disk magazine. "Number of storage elements" tells * us how many slots exist in the changer. * * The "first import/export element address" is the address of the first * medium portal accessible both by the medium changer and an outside * human operator. This is where the changer might deposit tapes destined * for some vault. The "number of import/export elements" tells us * not many of these portals exist in the changer. NOTE: this number may * be 0. * * The "first data transfer element address" is the address of the first * tape or disk drive in the changer. "Number of data transfer elements" * tells us how many drives exist in the changer. */ struct page_element_address_assignment { uint8_t pg_code; /* page code (0x1d) */ uint8_t pg_length; /* page length (0x12) */ /* Medium transport element address */ uint8_t mtea[2]; /* Number of medium transport elements */ uint8_t nmte[2]; /* First storage element address */ uint8_t fsea[2]; /* Number of storage elements */ uint8_t nse[2]; /* First import/export element address */ uint8_t fieea[2]; /* Number of import/export elements */ uint8_t niee[2]; /* First data transfer element address */ uint8_t fdtea[2]; /* Number of data transfer elements */ uint8_t ndte[2]; uint8_t reserved[2]; }; /* * Transport geometry parameters page. * * Defines whether each medium transport element is a member of a set of * elements that share a common robotics subsystem and whether the element * is capable of media rotation. One transport geometry descriptor is * transferred for each medium transport element, beginning with the first * medium transport element (other than the default transport element address * of 0). */ struct page_transport_geometry_parameters { uint8_t pg_code; /* page code (0x1e) */ uint8_t pg_length; /* page length; variable */ /* Transport geometry descriptor(s) are here. */ uint8_t misc; #define CAN_ROTATE 0x01 /* Member number in transport element set. */ uint8_t member; }; __BEGIN_DECLS void scsi_move_medium(struct ccb_scsiio *csio, uint32_t retries, void (*cbfcnp)(struct cam_periph *, union ccb *), uint8_t tag_action, uint32_t tea, uint32_t src, uint32_t dst, int invert, uint8_t sense_len, uint32_t timeout); void scsi_exchange_medium(struct ccb_scsiio *csio, uint32_t retries, void (*cbfcnp)(struct cam_periph *, union ccb *), uint8_t tag_action, uint32_t tea, uint32_t src, uint32_t dst1, uint32_t dst2, int invert1, int invert2, uint8_t sense_len, uint32_t timeout); void scsi_position_to_element(struct ccb_scsiio *csio, uint32_t retries, void (*cbfcnp)(struct cam_periph *, union ccb *), uint8_t tag_action, uint32_t tea, uint32_t dst, int invert, uint8_t sense_len, uint32_t timeout); void scsi_read_element_status(struct ccb_scsiio *csio, uint32_t retries, void (*cbfcnp)(struct cam_periph *, union ccb *), uint8_t tag_action, int voltag, uint32_t sea, int curdata, int dvcid, uint32_t count, uint8_t *data_ptr, uint32_t dxfer_len, uint8_t sense_len, uint32_t timeout); void scsi_initialize_element_status(struct ccb_scsiio *csio, uint32_t retries, void (*cbfcnp)(struct cam_periph *, union ccb *), uint8_t tag_action, uint8_t sense_len, uint32_t timeout); void scsi_send_volume_tag(struct ccb_scsiio *csio, uint32_t retries, void (*cbfcnp)(struct cam_periph *, union ccb *), uint8_t tag_action, uint16_t element_address, uint8_t send_action_code, struct scsi_send_volume_tag_parameters *parameters, uint8_t sense_len, uint32_t timeout); __END_DECLS #endif /* _SCSI_SCSI_CH_H */