chio.h revision 39248
1/* 2 * Copyright (c) 1996 Jason R. Thorpe <thorpej@and.com> 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 8 * 1. Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * 2. Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in the 12 * documentation and/or other materials provided with the distribution. 13 * 3. All advertising materials mentioning features or use of this software 14 * must display the following acknowledgements: 15 * This product includes software developed by Jason R. Thorpe 16 * for And Communications, http://www.and.com/ 17 * 4. The name of the author may not be used to endorse or promote products 18 * derived from this software without specific prior written permission. 19 * 20 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 21 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 22 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 23 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 24 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 25 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 26 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED 27 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 28 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 30 * SUCH DAMAGE. 31 * 32 * $Id: chio.h,v 1.11 1997/03/11 19:38:02 joerg Exp $ 33 */ 34 35#ifndef _SYS_CHIO_H_ 36#define _SYS_CHIO_H_ 37 38#ifndef KERNEL 39#include <sys/types.h> 40#endif 41#include <sys/ioccom.h> 42 43/* 44 * Element types. Used as "to" and "from" type indicators in move 45 * and exchange operations. 46 * 47 * Note that code in sys/scsi/ch.c relies on these values (uses them 48 * as offsets in an array, and other evil), so don't muck with them 49 * unless you know what you're doing. 50 */ 51#define CHET_MT 0 /* medium transport (picker) */ 52#define CHET_ST 1 /* storage transport (slot) */ 53#define CHET_IE 2 /* import/export (portal) */ 54#define CHET_DT 3 /* data transfer (drive) */ 55 56/* 57 * Maximum length of a volume identification string 58 */ 59#define CH_VOLTAG_MAXLEN 32 60 61/* 62 * Structure used to execute a MOVE MEDIUM command. 63 */ 64struct changer_move { 65 u_int16_t cm_fromtype; /* element type to move from */ 66 u_int16_t cm_fromunit; /* logical unit of from element */ 67 u_int16_t cm_totype; /* element type to move to */ 68 u_int16_t cm_tounit; /* logical unit of to element */ 69 u_int16_t cm_flags; /* misc. flags */ 70}; 71 72/* cm_flags */ 73#define CM_INVERT 0x01 /* invert media */ 74 75/* 76 * Structure used to execute an EXCHANGE MEDIUM command. In an 77 * exchange operation, the following steps occur: 78 * 79 * - media from source is moved to first destination. 80 * 81 * - media previously occupying first destination is moved 82 * to the second destination. 83 * 84 * The second destination may or may not be the same as the source. 85 * In the case of a simple exchange, the source and second destination 86 * are the same. 87 */ 88struct changer_exchange { 89 u_int16_t ce_srctype; /* element type of source */ 90 u_int16_t ce_srcunit; /* logical unit of source */ 91 u_int16_t ce_fdsttype; /* element type of first destination */ 92 u_int16_t ce_fdstunit; /* logical unit of first destination */ 93 u_int16_t ce_sdsttype; /* element type of second destination */ 94 u_int16_t ce_sdstunit; /* logical unit of second destination */ 95 u_int16_t ce_flags; /* misc. flags */ 96}; 97 98/* ce_flags */ 99#define CE_INVERT1 0x01 /* invert media 1 */ 100#define CE_INVERT2 0x02 /* invert media 2 */ 101 102/* 103 * Structure used to execute a POSITION TO ELEMENT command. This 104 * moves the current picker in front of the specified element. 105 */ 106struct changer_position { 107 u_int16_t cp_type; /* element type */ 108 u_int16_t cp_unit; /* logical unit of element */ 109 u_int16_t cp_flags; /* misc. flags */ 110}; 111 112/* cp_flags */ 113#define CP_INVERT 0x01 /* invert picker */ 114 115/* 116 * Data returned by CHIOGPARAMS. 117 */ 118struct changer_params { 119 u_int16_t cp_npickers; /* number of pickers */ 120 u_int16_t cp_nslots; /* number of slots */ 121 u_int16_t cp_nportals; /* number of import/export portals */ 122 u_int16_t cp_ndrives; /* number of drives */ 123}; 124 125/* 126 * Command used to get element status. 127 */ 128 129struct changer_voltag { 130 u_char cv_volid[CH_VOLTAG_MAXLEN+1]; 131 u_int16_t cv_serial; 132}; 133 134typedef struct changer_voltag changer_voltag_t; 135 136/* 137 * Flags definitions for ces_status 138 * Not all flags have meaning for all element types. 139 */ 140typedef enum { 141 CES_STATUS_FULL = 0x001, /* element is full */ 142 CES_STATUS_IMPEXP = 0x002, /* media deposited by operator */ 143 CES_STATUS_EXCEPT = 0x004, /* element in abnormal state */ 144 CES_PICKER_MASK = 0x005, /* flags valid for pickers */ 145 CES_STATUS_ACCESS = 0x008, /* media accessible by picker */ 146 CES_SLOT_MASK = 0x00c, /* flags valid for slots */ 147 CES_DRIVE_MASK = 0x00c, /* flags valid for drives */ 148 CES_STATUS_EXENAB = 0x010, /* element supports exporting */ 149 CES_STATUS_INENAB = 0x020, /* element supports importing */ 150 CES_PORTAL_MASK = 0x03f, /* flags valid for portals */ 151 CES_INVERT = 0x040, /* invert bit */ 152 CES_SOURCE_VALID = 0x080, /* source address (ces_source) valid */ 153 CES_SCSIID_VALID = 0x100, /* ces_scsi_id is valid */ 154 CES_LUN_VALID = 0x200, /* ces_scsi_lun is valid */ 155} ces_status_flags; 156 157struct changer_element_status { 158 u_int8_t ces_type; /* element type */ 159 u_int16_t ces_addr; /* logical element address */ 160 u_int16_t ces_int_addr; /* changer element address */ 161 ces_status_flags ces_flags; /* 162 * see CESTATUS definitions 163 * below 164 */ 165 u_int8_t ces_sensecode; /* 166 * additional sense 167 * code for element */ 168 u_int8_t ces_sensequal; /* 169 * additional sense 170 * code qualifier 171 */ 172 u_int8_t ces_source_type; /* 173 * element type of 174 * source address 175 */ 176 u_int16_t ces_source_addr; /* 177 * source address of medium 178 */ 179 changer_voltag_t ces_pvoltag; /* primary volume tag */ 180 changer_voltag_t ces_avoltag; /* alternate volume tag */ 181 u_int8_t ces_scsi_id; /* SCSI id of element */ 182 u_int8_t ces_scsi_lun; /* SCSI lun of element */ 183}; 184 185struct changer_element_status_request { 186 u_int16_t cesr_element_type; 187 u_int16_t cesr_element_base; 188 u_int16_t cesr_element_count; 189 190 u_int16_t cesr_flags; 191#define CESR_VOLTAGS 0x01 192 193 struct changer_element_status *cesr_element_status; 194}; 195 196 197struct changer_set_voltag_request { 198 u_int16_t csvr_type; 199 u_int16_t csvr_addr; 200 201 u_int16_t csvr_flags; 202#define CSVR_MODE_MASK 0x0f /* mode mask, acceptable modes below: */ 203#define CSVR_MODE_SET 0x00 /* set volume tag if not set */ 204#define CSVR_MODE_REPLACE 0x01 /* unconditionally replace volume tag */ 205#define CSVR_MODE_CLEAR 0x02 /* clear volume tag */ 206 207#define CSVR_ALTERNATE 0x10 /* set to work with alternate voltag */ 208 209 changer_voltag_t csvr_voltag; 210}; 211 212 213#define CESTATUS_BITS \ 214 "\20\6INEAB\5EXENAB\4ACCESS\3EXCEPT\2IMPEXP\1FULL" 215 216#define CHIOMOVE _IOW('c', 0x01, struct changer_move) 217#define CHIOEXCHANGE _IOW('c', 0x02, struct changer_exchange) 218#define CHIOPOSITION _IOW('c', 0x03, struct changer_position) 219#define CHIOGPICKER _IOR('c', 0x04, int) 220#define CHIOSPICKER _IOW('c', 0x05, int) 221#define CHIOGPARAMS _IOR('c', 0x06, struct changer_params) 222#define CHIOIELEM _IOW('c', 0x07, u_int32_t) 223#define CHIOGSTATUS _IOW('c', 0x08, struct changer_element_status_request) 224#define CHIOSETVOLTAG _IOW('c', 0x09, struct changer_set_voltag_request) 225 226#endif /* !_SYS_CHIO_H_ */ 227