1 /*- 2 * Copyright (c) 1982, 1986, 1993 3 * The Regents of the University of California. 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 * 4. Neither the name of the University nor the names of its contributors 14 * may be used to endorse or promote products derived from this software 15 * without specific prior written permission. 16 * 17 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 20 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 27 * SUCH DAMAGE. 28 * 29 * @(#)mtio.h 8.1 (Berkeley) 6/2/93 30 * $FreeBSD: stable/7/sys/sys/mtio.h 139825 2005-01-07 02:29:27Z imp $ 31 */ 32 33 #ifndef _SYS_MTIO_H_ 34 #define _SYS_MTIO_H_ 35 36 #ifndef _KERNEL 37 #include <sys/types.h> 38 #endif 39 #include <sys/ioccom.h> 40 41 /* 42 * Structures and definitions for mag tape io control commands 43 */ 44 45 /* structure for MTIOCTOP - mag tape op command */ 46 struct mtop { 47 short mt_op; /* operations defined below */ 48 int32_t mt_count; /* how many of them */ 49 }; 50 51 /* operations */ 52 #define MTWEOF 0 /* write an end-of-file record */ 53 #define MTFSF 1 /* forward space file */ 54 #define MTBSF 2 /* backward space file */ 55 #define MTFSR 3 /* forward space record */ 56 #define MTBSR 4 /* backward space record */ 57 #define MTREW 5 /* rewind */ 58 #define MTOFFL 6 /* rewind and put the drive offline */ 59 #define MTNOP 7 /* no operation, sets status only */ 60 #define MTCACHE 8 /* enable controller cache */ 61 #define MTNOCACHE 9 /* disable controller cache */ 62 63 #if defined(__FreeBSD__) 64 /* Set block size for device. If device is a variable size dev */ 65 /* a non zero parameter will change the device to a fixed block size */ 66 /* device with block size set to that of the parameter passed in. */ 67 /* Resetting the block size to 0 will restore the device to a variable */ 68 /* block size device. */ 69 70 #define MTSETBSIZ 10 71 72 /* Set density values for device. Sets the value for the opened mode only. */ 73 74 #define MTSETDNSTY 11 75 76 #define MTERASE 12 /* erase to EOM */ 77 #define MTEOD 13 /* Space to EOM */ 78 #define MTCOMP 14 /* select compression mode 0=off, 1=def */ 79 #define MTRETENS 15 /* re-tension tape */ 80 #define MTWSS 16 /* write setmark(s) */ 81 #define MTFSS 17 /* forward space setmark */ 82 #define MTBSS 18 /* backward space setmark */ 83 84 #define MT_COMP_ENABLE 0xffffffff 85 #define MT_COMP_DISABLED 0xfffffffe 86 #define MT_COMP_UNSUPP 0xfffffffd 87 88 /* 89 * Values in mt_dsreg that say what the device is doing 90 */ 91 #define MTIO_DSREG_NIL 0 /* Unknown */ 92 #define MTIO_DSREG_REST 1 /* Doing Nothing */ 93 #define MTIO_DSREG_RBSY 2 /* Communicating with tape (but no motion) */ 94 #define MTIO_DSREG_WR 20 /* Writing */ 95 #define MTIO_DSREG_FMK 21 /* Writing Filemarks */ 96 #define MTIO_DSREG_ZER 22 /* Erasing */ 97 #define MTIO_DSREG_RD 30 /* Reading */ 98 #define MTIO_DSREG_FWD 40 /* Spacing Forward */ 99 #define MTIO_DSREG_REV 41 /* Spacing Reverse */ 100 #define MTIO_DSREG_POS 42 /* Hardware Positioning (direction unknown) */ 101 #define MTIO_DSREG_REW 43 /* Rewinding */ 102 #define MTIO_DSREG_TEN 44 /* Retensioning */ 103 #define MTIO_DSREG_UNL 45 /* Unloading */ 104 #define MTIO_DSREG_LD 46 /* Loading */ 105 106 #endif /* __FreeBSD__ */ 107 108 /* structure for MTIOCGET - mag tape get status command */ 109 110 struct mtget { 111 short mt_type; /* type of magtape device */ 112 /* the following two registers are grossly device dependent */ 113 short mt_dsreg; /* ``drive status'' register */ 114 short mt_erreg; /* ``error'' register */ 115 /* end device-dependent registers */ 116 /* 117 * Note that the residual count, while maintained, may be 118 * be nonsense because the size of the residual may (greatly) 119 * exceed 32 K-bytes. Use the MTIOCERRSTAT ioctl to get a 120 * more accurate count. 121 */ 122 short mt_resid; /* residual count */ 123 #if defined (__FreeBSD__) 124 int32_t mt_blksiz; /* presently operating blocksize */ 125 int32_t mt_density; /* presently operating density */ 126 u_int32_t mt_comp; /* presently operating compression */ 127 int32_t mt_blksiz0; /* blocksize for mode 0 */ 128 int32_t mt_blksiz1; /* blocksize for mode 1 */ 129 int32_t mt_blksiz2; /* blocksize for mode 2 */ 130 int32_t mt_blksiz3; /* blocksize for mode 3 */ 131 int32_t mt_density0; /* density for mode 0 */ 132 int32_t mt_density1; /* density for mode 1 */ 133 int32_t mt_density2; /* density for mode 2 */ 134 int32_t mt_density3; /* density for mode 3 */ 135 /* the following are not yet implemented */ 136 u_int32_t mt_comp0; /* compression type for mode 0 */ 137 u_int32_t mt_comp1; /* compression type for mode 1 */ 138 u_int32_t mt_comp2; /* compression type for mode 2 */ 139 u_int32_t mt_comp3; /* compression type for mode 3 */ 140 /* end not yet implemented */ 141 #endif 142 int32_t mt_fileno; /* relative file number of current position */ 143 int32_t mt_blkno; /* relative block number of current position */ 144 }; 145 146 /* structure for MTIOCERRSTAT - tape get error status command */ 147 /* really only supported for SCSI tapes right now */ 148 struct scsi_tape_errors { 149 /* 150 * These are latched from the last command that had a SCSI 151 * Check Condition noted for these operations. The act 152 * of issuing an MTIOCERRSTAT unlatches and clears them. 153 */ 154 u_int8_t io_sense[32]; /* Last Sense Data For Data I/O */ 155 int32_t io_resid; /* residual count from last Data I/O */ 156 u_int8_t io_cdb[16]; /* Command that Caused the Last Data Sense */ 157 u_int8_t ctl_sense[32]; /* Last Sense Data For Control I/O */ 158 int32_t ctl_resid; /* residual count from last Control I/O */ 159 u_int8_t ctl_cdb[16]; /* Command that Caused the Last Control Sense */ 160 /* 161 * These are the read and write cumulative error counters. 162 * (how to reset cumulative error counters is not yet defined). 163 * (not implemented as yet but space is being reserved for them) 164 */ 165 struct { 166 u_int32_t retries; /* total # retries performed */ 167 u_int32_t corrected; /* total # corrections performed */ 168 u_int32_t processed; /* total # corrections successful */ 169 u_int32_t failures; /* total # corrections/retries failed */ 170 u_int64_t nbytes; /* total # bytes processed */ 171 } wterr, rderr; 172 }; 173 174 union mterrstat { 175 struct scsi_tape_errors scsi_errstat; 176 char _reserved_padding[256]; 177 }; 178 179 /* 180 * Constants for mt_type byte. These are the same 181 * for controllers compatible with the types listed. 182 */ 183 #define MT_ISTS 0x01 /* TS-11 */ 184 #define MT_ISHT 0x02 /* TM03 Massbus: TE16, TU45, TU77 */ 185 #define MT_ISTM 0x03 /* TM11/TE10 Unibus */ 186 #define MT_ISMT 0x04 /* TM78/TU78 Massbus */ 187 #define MT_ISUT 0x05 /* SI TU-45 emulation on Unibus */ 188 #define MT_ISCPC 0x06 /* SUN */ 189 #define MT_ISAR 0x07 /* SUN */ 190 #define MT_ISTMSCP 0x08 /* DEC TMSCP protocol (TU81, TK50) */ 191 #define MT_ISCY 0x09 /* CCI Cipher */ 192 #define MT_ISCT 0x0a /* HP 1/4 tape */ 193 #define MT_ISFHP 0x0b /* HP 7980 1/2 tape */ 194 #define MT_ISEXABYTE 0x0c /* Exabyte */ 195 #define MT_ISEXA8200 0x0c /* Exabyte EXB-8200 */ 196 #define MT_ISEXA8500 0x0d /* Exabyte EXB-8500 */ 197 #define MT_ISVIPER1 0x0e /* Archive Viper-150 */ 198 #define MT_ISPYTHON 0x0f /* Archive Python (DAT) */ 199 #define MT_ISHPDAT 0x10 /* HP 35450A DAT drive */ 200 #define MT_ISMFOUR 0x11 /* M4 Data 1/2 9track drive */ 201 #define MT_ISTK50 0x12 /* DEC SCSI TK50 */ 202 #define MT_ISMT02 0x13 /* Emulex MT02 SCSI tape controller */ 203 204 /* mag tape io control commands */ 205 #define MTIOCTOP _IOW('m', 1, struct mtop) /* do a mag tape op */ 206 #define MTIOCGET _IOR('m', 2, struct mtget) /* get tape status */ 207 /* these two do not appear to be used anywhere */ 208 #define MTIOCIEOT _IO('m', 3) /* ignore EOT error */ 209 #define MTIOCEEOT _IO('m', 4) /* enable EOT error */ 210 /* 211 * When more SCSI-3 SSC (streaming device) devices are out there 212 * that support the full 32 byte type 2 structure, we'll have to 213 * rethink these ioctls to support all the entities they haul into 214 * the picture (64 bit blocks, logical file record numbers, etc..). 215 */ 216 #define MTIOCRDSPOS _IOR('m', 5, u_int32_t) /* get logical blk addr */ 217 #define MTIOCRDHPOS _IOR('m', 6, u_int32_t) /* get hardware blk addr */ 218 #define MTIOCSLOCATE _IOW('m', 5, u_int32_t) /* seek to logical blk addr */ 219 #define MTIOCHLOCATE _IOW('m', 6, u_int32_t) /* seek to hardware blk addr */ 220 #define MTIOCERRSTAT _IOR('m', 7, union mterrstat) /* get tape errors */ 221 /* 222 * Set EOT model- argument is number of filemarks to end a tape with. 223 * Note that not all possible values will be accepted. 224 */ 225 #define MTIOCSETEOTMODEL _IOW('m', 8, u_int32_t) 226 /* Get current EOT model */ 227 #define MTIOCGETEOTMODEL _IOR('m', 8, u_int32_t) 228 229 #ifndef _KERNEL 230 #define DEFTAPE "/dev/nsa0" 231 #endif 232 233 #endif /* !_SYS_MTIO_H_ */ 234