sys/sys/mtio.h

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