2 /* $NetBSD: scsi_changer.h,v 1.11 1998/02/13 08:28:32 enami Exp $ */
5 * SPDX-License-Identifier: BSD-4-Clause
7 * Copyright (c) 1996 Jason R. Thorpe <thorpej@and.com>
10 * Partially based on an autochanger driver written by Stefan Grefen
11 * and on an autochanger driver written by the Systems Programming Group
12 * at the University of Utah Computer Science Department.
14 * Redistribution and use in source and binary forms, with or without
15 * modification, are permitted provided that the following conditions
17 * 1. Redistributions of source code must retain the above copyright
18 * notice, this list of conditions and the following disclaimer.
19 * 2. Redistributions in binary form must reproduce the above copyright
20 * notice, this list of conditions and the following disclaimer in the
21 * documentation and/or other materials provided with the distribution.
22 * 3. All advertising materials mentioning features or use of this software
23 * must display the following acknowledgements:
24 * This product includes software developed by Jason R. Thorpe
25 * for And Communications, http://www.and.com/
26 * 4. The name of the author may not be used to endorse or promote products
27 * derived from this software without specific prior written permission.
29 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
30 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
31 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
32 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
33 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
34 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
35 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
36 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
37 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
38 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
43 * SCSI changer interface description
47 * Partially derived from software written by Stefan Grefen
48 * (grefen@goofy.zdv.uni-mainz.de soon grefen@convex.com)
49 * based on the SCSI System by written Julian Elischer (julian@tfs.com)
50 * for TRW Financial Systems.
52 * TRW Financial Systems, in accordance with their agreement with Carnegie
53 * Mellon University, makes this software available to CMU to distribute
54 * or use in any manner that they see fit as long as this message is kept with
55 * the software. For this reason TFS also grants any other persons or
56 * organisations permission to use or modify this software.
58 * TFS supplies this software to be publicly redistributed
59 * on the understanding that TFS is not responsible for the correct
60 * functioning of this software in any circumstances.
62 * Ported to run under 386BSD by Julian Elischer (julian@tfs.com) Sept 1992
65 #ifndef _SCSI_SCSI_CH_H
66 #define _SCSI_SCSI_CH_H 1
68 #include <sys/cdefs.h>
75 * Exchange the medium in the source element with the medium
76 * located at the destination element.
78 struct scsi_exchange_medium {
80 #define EXCHANGE_MEDIUM 0xa6
82 u_int8_t tea[2]; /* transport element address */
83 u_int8_t src[2]; /* source address */
84 u_int8_t fdst[2]; /* first destination address */
85 u_int8_t sdst[2]; /* second destination address */
87 #define EXCHANGE_MEDIUM_INV1 0x01
88 #define EXCHANGE_MEDIUM_INV2 0x02
93 * Cause the medium changer to check all elements for medium and any
94 * other status relevant to the element.
96 struct scsi_initialize_element_status {
98 #define INITIALIZE_ELEMENT_STATUS 0x07
100 u_int8_t reserved[3];
105 * Request the changer to move a unit of media from the source element
106 * to the destination element.
108 struct scsi_move_medium {
111 u_int8_t tea[2]; /* transport element address */
112 u_int8_t src[2]; /* source element address */
113 u_int8_t dst[2]; /* destination element address */
114 u_int8_t reserved[2];
116 #define MOVE_MEDIUM_INVERT 0x01
121 * Position the specified transport element (picker) in front of
122 * the destination element specified.
124 struct scsi_position_to_element {
127 u_int8_t tea[2]; /* transport element address */
128 u_int8_t dst[2]; /* destination element address */
129 u_int8_t reserved[2];
131 #define POSITION_TO_ELEMENT_INVERT 0x01
136 * Request that the changer report the status of its internal elements.
138 struct scsi_read_element_status {
141 #define READ_ELEMENT_STATUS_VOLTAG 0x10 /* report volume tag info */
142 /* ...next 4 bits are an element type code... */
143 u_int8_t sea[2]; /* starting element address */
144 u_int8_t count[2]; /* number of elements */
146 #define READ_ELEMENT_STATUS_DVCID 0x01 /* report device serial number */
147 #define READ_ELEMENT_STATUS_CURDATA 0x02 /* allow motion during command */
149 u_int8_t len[3]; /* length of data buffer */
154 struct scsi_request_volume_element_address {
157 #define REQUEST_VOLUME_ELEMENT_ADDRESS_VOLTAG 0x10
158 /* ...next 4 bits are an element type code... */
159 u_int8_t eaddr[2]; /* element address */
160 u_int8_t count[2]; /* number of elements */
162 u_int8_t len[3]; /* length of data buffer */
167 /* XXX scsi_release */
170 * Changer-specific mode page numbers.
172 #define CH_ELEMENT_ADDR_ASSIGN_PAGE 0x1D
173 #define CH_TRANS_GEOM_PARAMS_PAGE 0x1E
174 #define CH_DEVICE_CAP_PAGE 0x1F
177 * Data returned by READ ELEMENT STATUS consists of an 8-byte header
178 * followed by one or more read_element_status_pages.
180 struct read_element_status_header {
181 u_int8_t fear[2]; /* first element address reported */
182 u_int8_t count[2]; /* number of elements available */
184 u_int8_t nbytes[3]; /* byte count of all pages */
187 struct read_element_status_page_header {
188 u_int8_t type; /* element type code; see type codes below */
190 #define READ_ELEMENT_STATUS_AVOLTAG 0x40
191 #define READ_ELEMENT_STATUS_PVOLTAG 0x80
192 u_int8_t edl[2]; /* element descriptor length */
194 u_int8_t nbytes[3]; /* byte count of all descriptors */
198 * Format of a volume tag
202 u_int8_t vif[32]; /* volume identification field */
203 u_int8_t reserved[2];
204 u_int8_t vsn[2]; /* volume sequence number */
207 struct read_element_status_device_id {
208 u_int8_t prot_code_set;
209 #define READ_ELEMENT_STATUS_CODE_SET(p) ((p) & 0x0F)
210 #define READ_ELEMENT_STATUS_PROTOCOL_ID(p) ((p) >> 4)
212 u_int8_t piv_assoc_designator_type;
213 #define READ_ELEMENT_STATUS_PIV_SET 0x80
214 #define READ_ELEMENT_STATUS_ASSOCIATION(p) ((p) >> 4)
215 #define READ_ELEMENT_STATUS_DESIGNATOR_TYPE(p) ((p) & 0x0F)
218 u_int8_t designator_length;
219 u_int8_t designator[256]; /* Allocate max length */
222 struct read_element_status_descriptor {
223 u_int8_t eaddr[2]; /* element address */
226 #define READ_ELEMENT_STATUS_FULL 0x01
227 #define READ_ELEMENT_STATUS_IMPEXP 0x02
228 #define READ_ELEMENT_STATUS_EXCEPT 0x04
229 #define READ_ELEMENT_STATUS_ACCESS 0x08
230 #define READ_ELEMENT_STATUS_EXENAB 0x10
231 #define READ_ELEMENT_STATUS_INENAB 0x20
233 #define READ_ELEMENT_STATUS_MT_MASK1 0x05
234 #define READ_ELEMENT_STATUS_ST_MASK1 0x0c
235 #define READ_ELEMENT_STATUS_IE_MASK1 0x3f
236 #define READ_ELEMENT_STATUS_DT_MASK1 0x0c
244 u_int8_t dt_scsi_flags;
246 #define READ_ELEMENT_STATUS_DT_LUNMASK 0x07
247 #define READ_ELEMENT_STATUS_DT_LUVALID 0x10
248 #define READ_ELEMENT_STATUS_DT_IDVALID 0x20
249 #define READ_ELEMENT_STATUS_DT_NOTBUS 0x80
251 u_int8_t dt_scsi_addr;
255 /* reserved and obsolete (as of SCSI-3) fields */
256 u_int8_t reserved_or_obsolete[3];
260 #define READ_ELEMENT_STATUS_INVERT 0x40
261 #define READ_ELEMENT_STATUS_SVALID 0x80
262 #define READ_ELEMENT_STATUS_ED 0x80
263 #define READ_ELEMENT_STATUS_MEDIA_TYPE_MASK 0x07
265 u_int8_t ssea[2]; /* source storage element address */
268 struct volume_tag pvoltag;
269 struct volume_tag voltag[2];
270 struct read_element_status_device_id devid;
272 struct volume_tag pvoltag;
273 struct read_element_status_device_id devid;
276 struct volume_tag voltag[2];
277 struct read_element_status_device_id devid;
278 } vol_tags_and_devid;
282 /* XXX add data returned by REQUEST VOLUME ELEMENT ADDRESS */
284 /* Element type codes */
285 #define ELEMENT_TYPE_MASK 0x0f /* Note: these aren't bits */
286 #define ELEMENT_TYPE_ALL 0x00
287 #define ELEMENT_TYPE_MT 0x01
288 #define ELEMENT_TYPE_ST 0x02
289 #define ELEMENT_TYPE_IE 0x03
290 #define ELEMENT_TYPE_DT 0x04
293 * XXX The following definitions should be common to all SCSI device types.
295 #define PGCODE_MASK 0x3f /* valid page number bits in pg_code */
296 #define PGCODE_PS 0x80 /* indicates page is savable */
299 * Send volume tag information to the changer
302 struct scsi_send_volume_tag {
304 #define SEND_VOLUME_TAG 0xb6
306 u_int8_t ea[2]; /* element address */
308 u_int8_t sac; /* send action code */
310 #define SEND_VOLUME_TAG_ASSERT_PRIMARY 0x08
311 #define SEND_VOLUME_TAG_ASSERT_ALTERNATE 0x09
312 #define SEND_VOLUME_TAG_REPLACE_PRIMARY 0x0a
313 #define SEND_VOLUME_TAG_REPLACE_ALTERNATE 0x0b
314 #define SEND_VOLUME_TAG_UNDEFINED_PRIMARY 0x0c
315 #define SEND_VOLUME_TAG_UNDEFINED_ALTERNATE 0x0d
317 u_int8_t reserved4[2];
318 u_int8_t pll[2]; /* parameter list length */
324 * Parameter format for SEND VOLUME TAG
327 struct scsi_send_volume_tag_parameters {
328 u_int8_t vitf[32]; /* volume tag identification template */
329 u_int8_t reserved1[2];
330 u_int8_t minvsn[2]; /* minimum volume sequence number */
331 u_int8_t reserved2[2];
332 u_int8_t maxvsn[2]; /* maximum volume sequence number */
336 * Device capabilities page.
338 * This page defines characteristics of the element types in the
339 * medium changer device.
341 * Note in the definitions below, the following abbreviations are
343 * MT Medium transport element (picker)
344 * ST Storage transport element (slot)
345 * IE Import/export element (portal)
346 * DT Data transfer element (tape/disk drive)
348 struct page_device_capabilities {
349 u_int8_t pg_code; /* page code (0x1f) */
350 u_int8_t pg_length; /* page length (0x12) */
353 * The STOR_xx bits indicate that an element of a given
354 * type may provide independent storage for a unit of
355 * media. The top four bits of this value are reserved.
366 * The MOVE_TO_yy bits indicate the changer supports
367 * moving a unit of medium from an element of a given type to an
368 * element of type yy. This is used to determine if a given
369 * MOVE MEDIUM command is legal. The top four bits of each
370 * of these values are reserved.
372 u_int8_t move_from[CHET_MAX + 1];
373 #define MOVE_TO_MT 0x01
374 #define MOVE_TO_ST 0x02
375 #define MOVE_TO_IE 0x04
376 #define MOVE_TO_DT 0x08
378 u_int8_t reserved1[4];
381 * Similar to above, but for EXCHANGE MEDIUM.
383 u_int8_t exchange_with[CHET_MAX + 1];
384 #define EXCHANGE_WITH_MT 0x01
385 #define EXCHANGE_WITH_ST 0x02
386 #define EXCHANGE_WITH_IE 0x04
387 #define EXCHANGE_WITH_DT 0x08
391 * Medium changer elemement address assignment page.
393 * Some of these fields can be a little confusing, so an explanation
396 * Each component within a medium changer apparatus is called an
399 * The "medium transport element address" is the address of the first
400 * picker (robotic arm). "Number of medium transport elements" tells
401 * us how many pickers exist in the changer.
403 * The "first storage element address" is the address of the first
404 * slot in the tape or disk magazine. "Number of storage elements" tells
405 * us how many slots exist in the changer.
407 * The "first import/export element address" is the address of the first
408 * medium portal accessible both by the medium changer and an outside
409 * human operator. This is where the changer might deposit tapes destined
410 * for some vault. The "number of import/export elements" tells us
411 * not many of these portals exist in the changer. NOTE: this number may
414 * The "first data transfer element address" is the address of the first
415 * tape or disk drive in the changer. "Number of data transfer elements"
416 * tells us how many drives exist in the changer.
418 struct page_element_address_assignment {
419 u_int8_t pg_code; /* page code (0x1d) */
420 u_int8_t pg_length; /* page length (0x12) */
422 /* Medium transport element address */
425 /* Number of medium transport elements */
428 /* First storage element address */
431 /* Number of storage elements */
434 /* First import/export element address */
437 /* Number of import/export elements */
440 /* First data transfer element address */
443 /* Number of data trafer elements */
446 u_int8_t reserved[2];
450 * Transport geometry parameters page.
452 * Defines whether each medium transport element is a member of a set of
453 * elements that share a common robotics subsystem and whether the element
454 * is capable of media rotation. One transport geometry descriptor is
455 * transferred for each medium transport element, beginning with the first
456 * medium transport element (other than the default transport element address
459 struct page_transport_geometry_parameters {
460 u_int8_t pg_code; /* page code (0x1e) */
461 u_int8_t pg_length; /* page length; variable */
463 /* Transport geometry descriptor(s) are here. */
466 #define CAN_ROTATE 0x01
468 /* Member number in transport element set. */
473 void scsi_move_medium(struct ccb_scsiio *csio, u_int32_t retries,
474 void (*cbfcnp)(struct cam_periph *, union ccb *),
475 u_int8_t tag_action, u_int32_t tea, u_int32_t src,
476 u_int32_t dst, int invert, u_int8_t sense_len,
479 void scsi_exchange_medium(struct ccb_scsiio *csio, u_int32_t retries,
480 void (*cbfcnp)(struct cam_periph *, union ccb *),
481 u_int8_t tag_action, u_int32_t tea, u_int32_t src,
482 u_int32_t dst1, u_int32_t dst2, int invert1,
483 int invert2, u_int8_t sense_len, u_int32_t timeout);
485 void scsi_position_to_element(struct ccb_scsiio *csio, u_int32_t retries,
486 void (*cbfcnp)(struct cam_periph *, union ccb *),
487 u_int8_t tag_action, u_int32_t tea, u_int32_t dst,
488 int invert, u_int8_t sense_len,
491 void scsi_read_element_status(struct ccb_scsiio *csio, u_int32_t retries,
492 void (*cbfcnp)(struct cam_periph *, union ccb *),
493 u_int8_t tag_action, int voltag, u_int32_t sea,
494 int curdata, int dvcid,
495 u_int32_t count, u_int8_t *data_ptr,
496 u_int32_t dxfer_len, u_int8_t sense_len,
499 void scsi_initialize_element_status(struct ccb_scsiio *csio, u_int32_t retries,
500 void (*cbfcnp)(struct cam_periph *, union ccb *),
501 u_int8_t tag_action, u_int8_t sense_len,
503 void scsi_send_volume_tag(struct ccb_scsiio *csio, u_int32_t retries,
504 void (*cbfcnp)(struct cam_periph *, union ccb *),
506 u_int16_t element_address,
507 u_int8_t send_action_code,
508 struct scsi_send_volume_tag_parameters *parameters,
509 u_int8_t sense_len, u_int32_t timeout);
512 #endif /* _SCSI_SCSI_CH_H */