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 * $FreeBSD: src/sys/sys/chio.h,v 1.15 1999/12/29 04:24:38 peter Exp $ 33 * $DragonFly: src/sys/sys/chio.h,v 1.3 2006/05/20 02:42:13 dillon Exp $ 34 */ 35 36 #ifndef _SYS_CHIO_H_ 37 #define _SYS_CHIO_H_ 38 39 #ifndef _SYS_TYPES_H_ 40 #include <sys/types.h> 41 #endif 42 #ifndef _SYS_IOCCOM_H_ 43 #include <sys/ioccom.h> 44 #endif 45 46 /* 47 * Element types. Used as "to" and "from" type indicators in move 48 * and exchange operations. 49 * 50 * Note that code in sys/scsi/ch.c relies on these values (uses them 51 * as offsets in an array, and other evil), so don't muck with them 52 * unless you know what you're doing. 53 */ 54 #define CHET_MT 0 /* medium transport (picker) */ 55 #define CHET_ST 1 /* storage transport (slot) */ 56 #define CHET_IE 2 /* import/export (portal) */ 57 #define CHET_DT 3 /* data transfer (drive) */ 58 59 /* 60 * Maximum length of a volume identification string 61 */ 62 #define CH_VOLTAG_MAXLEN 32 63 64 /* 65 * Structure used to execute a MOVE MEDIUM command. 66 */ 67 struct changer_move { 68 u_int16_t cm_fromtype; /* element type to move from */ 69 u_int16_t cm_fromunit; /* logical unit of from element */ 70 u_int16_t cm_totype; /* element type to move to */ 71 u_int16_t cm_tounit; /* logical unit of to element */ 72 u_int16_t cm_flags; /* misc. flags */ 73 }; 74 75 /* cm_flags */ 76 #define CM_INVERT 0x01 /* invert media */ 77 78 /* 79 * Structure used to execute an EXCHANGE MEDIUM command. In an 80 * exchange operation, the following steps occur: 81 * 82 * - media from source is moved to first destination. 83 * 84 * - media previously occupying first destination is moved 85 * to the second destination. 86 * 87 * The second destination may or may not be the same as the source. 88 * In the case of a simple exchange, the source and second destination 89 * are the same. 90 */ 91 struct changer_exchange { 92 u_int16_t ce_srctype; /* element type of source */ 93 u_int16_t ce_srcunit; /* logical unit of source */ 94 u_int16_t ce_fdsttype; /* element type of first destination */ 95 u_int16_t ce_fdstunit; /* logical unit of first destination */ 96 u_int16_t ce_sdsttype; /* element type of second destination */ 97 u_int16_t ce_sdstunit; /* logical unit of second destination */ 98 u_int16_t ce_flags; /* misc. flags */ 99 }; 100 101 /* ce_flags */ 102 #define CE_INVERT1 0x01 /* invert media 1 */ 103 #define CE_INVERT2 0x02 /* invert media 2 */ 104 105 /* 106 * Structure used to execute a POSITION TO ELEMENT command. This 107 * moves the current picker in front of the specified element. 108 */ 109 struct changer_position { 110 u_int16_t cp_type; /* element type */ 111 u_int16_t cp_unit; /* logical unit of element */ 112 u_int16_t cp_flags; /* misc. flags */ 113 }; 114 115 /* cp_flags */ 116 #define CP_INVERT 0x01 /* invert picker */ 117 118 /* 119 * Data returned by CHIOGPARAMS. 120 */ 121 struct changer_params { 122 u_int16_t cp_npickers; /* number of pickers */ 123 u_int16_t cp_nslots; /* number of slots */ 124 u_int16_t cp_nportals; /* number of import/export portals */ 125 u_int16_t cp_ndrives; /* number of drives */ 126 }; 127 128 /* 129 * Command used to get element status. 130 */ 131 132 struct changer_voltag { 133 u_char cv_volid[CH_VOLTAG_MAXLEN+1]; 134 u_int16_t cv_serial; 135 }; 136 137 typedef struct changer_voltag changer_voltag_t; 138 139 /* 140 * Flags definitions for ces_status 141 * Not all flags have meaning for all element types. 142 */ 143 typedef enum { 144 CES_STATUS_FULL = 0x001, /* element is full */ 145 CES_STATUS_IMPEXP = 0x002, /* media deposited by operator */ 146 CES_STATUS_EXCEPT = 0x004, /* element in abnormal state */ 147 CES_PICKER_MASK = 0x005, /* flags valid for pickers */ 148 CES_STATUS_ACCESS = 0x008, /* media accessible by picker */ 149 CES_SLOT_MASK = 0x00c, /* flags valid for slots */ 150 CES_DRIVE_MASK = 0x00c, /* flags valid for drives */ 151 CES_STATUS_EXENAB = 0x010, /* element supports exporting */ 152 CES_STATUS_INENAB = 0x020, /* element supports importing */ 153 CES_PORTAL_MASK = 0x03f, /* flags valid for portals */ 154 CES_INVERT = 0x040, /* invert bit */ 155 CES_SOURCE_VALID = 0x080, /* source address (ces_source) valid */ 156 CES_SCSIID_VALID = 0x100, /* ces_scsi_id is valid */ 157 CES_LUN_VALID = 0x200 /* ces_scsi_lun is valid */ 158 } ces_status_flags; 159 160 struct changer_element_status { 161 u_int8_t ces_type; /* element type */ 162 u_int16_t ces_addr; /* logical element address */ 163 u_int16_t ces_int_addr; /* changer element address */ 164 ces_status_flags ces_flags; /* 165 * see CESTATUS definitions 166 * below 167 */ 168 u_int8_t ces_sensecode; /* 169 * additional sense 170 * code for element */ 171 u_int8_t ces_sensequal; /* 172 * additional sense 173 * code qualifier 174 */ 175 u_int8_t ces_source_type; /* 176 * element type of 177 * source address 178 */ 179 u_int16_t ces_source_addr; /* 180 * source address of medium 181 */ 182 changer_voltag_t ces_pvoltag; /* primary volume tag */ 183 changer_voltag_t ces_avoltag; /* alternate volume tag */ 184 u_int8_t ces_scsi_id; /* SCSI id of element */ 185 u_int8_t ces_scsi_lun; /* SCSI lun of element */ 186 }; 187 188 struct changer_element_status_request { 189 u_int16_t cesr_element_type; 190 u_int16_t cesr_element_base; 191 u_int16_t cesr_element_count; 192 193 u_int16_t cesr_flags; 194 #define CESR_VOLTAGS 0x01 195 196 struct changer_element_status *cesr_element_status; 197 }; 198 199 200 struct changer_set_voltag_request { 201 u_int16_t csvr_type; 202 u_int16_t csvr_addr; 203 204 u_int16_t csvr_flags; 205 #define CSVR_MODE_MASK 0x0f /* mode mask, acceptable modes below: */ 206 #define CSVR_MODE_SET 0x00 /* set volume tag if not set */ 207 #define CSVR_MODE_REPLACE 0x01 /* unconditionally replace volume tag */ 208 #define CSVR_MODE_CLEAR 0x02 /* clear volume tag */ 209 210 #define CSVR_ALTERNATE 0x10 /* set to work with alternate voltag */ 211 212 changer_voltag_t csvr_voltag; 213 }; 214 215 216 #define CESTATUS_BITS \ 217 "\20\6INEAB\5EXENAB\4ACCESS\3EXCEPT\2IMPEXP\1FULL" 218 219 #define CHIOMOVE _IOW('c', 0x01, struct changer_move) 220 #define CHIOEXCHANGE _IOW('c', 0x02, struct changer_exchange) 221 #define CHIOPOSITION _IOW('c', 0x03, struct changer_position) 222 #define CHIOGPICKER _IOR('c', 0x04, int) 223 #define CHIOSPICKER _IOW('c', 0x05, int) 224 #define CHIOGPARAMS _IOR('c', 0x06, struct changer_params) 225 #define CHIOIELEM _IOW('c', 0x07, u_int32_t) 226 #define CHIOGSTATUS _IOW('c', 0x08, struct changer_element_status_request) 227 #define CHIOSETVOLTAG _IOW('c', 0x09, struct changer_set_voltag_request) 228 229 #endif /* !_SYS_CHIO_H_ */ 230