uapi/linux/mtio.h

0001 /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
0002 /*
0003  * linux/mtio.h header file for Linux. Written by H. Bergman
0004  *
0005  * Modified for special ioctls provided by zftape in September 1997
0006  * by C.-J. Heine.
0007  */
0008
0009 #ifndef _LINUX_MTIO_H
0010 #define _LINUX_MTIO_H
0011
0012 #include <linux/types.h>
0013 #include <linux/ioctl.h>
0014
0015 /*
0016  * Structures and definitions for mag tape io control commands
0017  */
0018
0019 /* structure for MTIOCTOP - mag tape op command */
0020 struct  mtop {
0021     short   mt_op;      /* operations defined below */
0022     int mt_count;   /* how many of them */
0023 };
0024
0025 /* Magnetic Tape operations [Not all operations supported by all drivers]: */
0026 #define MTRESET 0   /* +reset drive in case of problems */
0027 #define MTFSF   1   /* forward space over FileMark,
0028              * position at first record of next file
0029              */
0030 #define MTBSF   2   /* backward space FileMark (position before FM) */
0031 #define MTFSR   3   /* forward space record */
0032 #define MTBSR   4   /* backward space record */
0033 #define MTWEOF  5   /* write an end-of-file record (mark) */
0034 #define MTREW   6   /* rewind */
0035 #define MTOFFL  7   /* rewind and put the drive offline (eject?) */
0036 #define MTNOP   8   /* no op, set status only (read with MTIOCGET) */
0037 #define MTRETEN 9   /* retension tape */
0038 #define MTBSFM  10  /* +backward space FileMark, position at FM */
0039 #define MTFSFM  11  /* +forward space FileMark, position at FM */
0040 #define MTEOM   12  /* goto end of recorded media (for appending files).
0041              * MTEOM positions after the last FM, ready for
0042              * appending another file.
0043              */
0044 #define MTERASE 13  /* erase tape -- be careful! */
0045
0046 #define MTRAS1  14  /* run self test 1 (nondestructive) */
0047 #define MTRAS2  15  /* run self test 2 (destructive) */
0048 #define MTRAS3  16  /* reserved for self test 3 */
0049
0050 #define MTSETBLK 20 /* set block length (SCSI) */
0051 #define MTSETDENSITY 21 /* set tape density (SCSI) */
0052 #define MTSEEK  22  /* seek to block (Tandberg, etc.) */
0053 #define MTTELL  23  /* tell block (Tandberg, etc.) */
0054 #define MTSETDRVBUFFER 24 /* set the drive buffering according to SCSI-2 */
0055             /* ordinary buffered operation with code 1 */
0056 #define MTFSS   25  /* space forward over setmarks */
0057 #define MTBSS   26  /* space backward over setmarks */
0058 #define MTWSM   27  /* write setmarks */
0059
0060 #define MTLOCK  28  /* lock the drive door */
0061 #define MTUNLOCK 29 /* unlock the drive door */
0062 #define MTLOAD  30  /* execute the SCSI load command */
0063 #define MTUNLOAD 31 /* execute the SCSI unload command */
0064 #define MTCOMPRESSION 32/* control compression with SCSI mode page 15 */
0065 #define MTSETPART 33    /* Change the active tape partition */
0066 #define MTMKPART  34    /* Format the tape with one or two partitions */
0067 #define MTWEOFI 35  /* write an end-of-file record (mark) in immediate mode */
0068
0069 /* structure for MTIOCGET - mag tape get status command */
0070
0071 struct  mtget {
0072     long    mt_type;    /* type of magtape device */
0073     long    mt_resid;   /* residual count: (not sure)
0074                  *  number of bytes ignored, or
0075                  *  number of files not skipped, or
0076                  *  number of records not skipped.
0077                  */
0078     /* the following registers are device dependent */
0079     long    mt_dsreg;   /* status register */
0080     long    mt_gstat;   /* generic (device independent) status */
0081     long    mt_erreg;   /* error register */
0082     /* The next two fields are not always used */
0083     __kernel_daddr_t mt_fileno; /* number of current file on tape */
0084     __kernel_daddr_t mt_blkno;  /* current block number */
0085 };
0086
0087
0088
0089 /*
0090  * Constants for mt_type. Not all of these are supported,
0091  * and these are not all of the ones that are supported.
0092  */
0093 #define MT_ISUNKNOWN        0x01
0094 #define MT_ISQIC02      0x02    /* Generic QIC-02 tape streamer */
0095 #define MT_ISWT5150     0x03    /* Wangtek 5150EQ, QIC-150, QIC-02 */
0096 #define MT_ISARCHIVE_5945L2 0x04    /* Archive 5945L-2, QIC-24, QIC-02? */
0097 #define MT_ISCMSJ500        0x05    /* CMS Jumbo 500 (QIC-02?) */
0098 #define MT_ISTDC3610        0x06    /* Tandberg 6310, QIC-24 */
0099 #define MT_ISARCHIVE_VP60I  0x07    /* Archive VP60i, QIC-02 */
0100 #define MT_ISARCHIVE_2150L  0x08    /* Archive Viper 2150L */
0101 #define MT_ISARCHIVE_2060L  0x09    /* Archive Viper 2060L */
0102 #define MT_ISARCHIVESC499   0x0A    /* Archive SC-499 QIC-36 controller */
0103 #define MT_ISQIC02_ALL_FEATURES 0x0F    /* Generic QIC-02 with all features */
0104 #define MT_ISWT5099EEN24    0x11    /* Wangtek 5099-een24, 60MB, QIC-24 */
0105 #define MT_ISTEAC_MT2ST     0x12    /* Teac MT-2ST 155mb drive, Teac DC-1 card (Wangtek type) */
0106 #define MT_ISEVEREX_FT40A   0x32    /* Everex FT40A (QIC-40) */
0107 #define MT_ISDDS1       0x51    /* DDS device without partitions */
0108 #define MT_ISDDS2       0x52    /* DDS device with partitions */
0109 #define MT_ISONSTREAM_SC        0x61   /* OnStream SCSI tape drives (SC-x0)
0110                       and SCSI emulated (DI, DP, USB) */
0111 #define MT_ISSCSI1      0x71    /* Generic ANSI SCSI-1 tape unit */
0112 #define MT_ISSCSI2      0x72    /* Generic ANSI SCSI-2 tape unit */
0113
0114 /* QIC-40/80/3010/3020 ftape supported drives.
0115  * 20bit vendor ID + 0x800000 (see ftape-vendors.h)
0116  */
0117 #define MT_ISFTAPE_UNKNOWN  0x800000 /* obsolete */
0118 #define MT_ISFTAPE_FLAG 0x800000
0119
0120
0121 /* structure for MTIOCPOS - mag tape get position command */
0122
0123 struct  mtpos {
0124     long    mt_blkno;   /* current block number */
0125 };
0126
0127
0128 /* mag tape io control commands */
0129 #define MTIOCTOP    _IOW('m', 1, struct mtop)   /* do a mag tape op */
0130 #define MTIOCGET    _IOR('m', 2, struct mtget)  /* get tape status */
0131 #define MTIOCPOS    _IOR('m', 3, struct mtpos)  /* get tape position */
0132
0133
0134 /* Generic Mag Tape (device independent) status macros for examining
0135  * mt_gstat -- HP-UX compatible.
0136  * There is room for more generic status bits here, but I don't
0137  * know which of them are reserved. At least three or so should
0138  * be added to make this really useful.
0139  */
0140 #define GMT_EOF(x)              ((x) & 0x80000000)
0141 #define GMT_BOT(x)              ((x) & 0x40000000)
0142 #define GMT_EOT(x)              ((x) & 0x20000000)
0143 #define GMT_SM(x)               ((x) & 0x10000000)  /* DDS setmark */
0144 #define GMT_EOD(x)              ((x) & 0x08000000)  /* DDS EOD */
0145 #define GMT_WR_PROT(x)          ((x) & 0x04000000)
0146 /* #define GMT_ ?       ((x) & 0x02000000) */
0147 #define GMT_ONLINE(x)           ((x) & 0x01000000)
0148 #define GMT_D_6250(x)           ((x) & 0x00800000)
0149 #define GMT_D_1600(x)           ((x) & 0x00400000)
0150 #define GMT_D_800(x)            ((x) & 0x00200000)
0151 /* #define GMT_ ?       ((x) & 0x00100000) */
0152 /* #define GMT_ ?       ((x) & 0x00080000) */
0153 #define GMT_DR_OPEN(x)          ((x) & 0x00040000)  /* door open (no tape) */
0154 /* #define GMT_ ?       ((x) & 0x00020000) */
0155 #define GMT_IM_REP_EN(x)        ((x) & 0x00010000)  /* immediate report mode */
0156 #define GMT_CLN(x)              ((x) & 0x00008000)  /* cleaning requested */
0157 /* 15 generic status bits unused */
0158
0159
0160 /* SCSI-tape specific definitions */
0161 /* Bitfield shifts in the status  */
0162 #define MT_ST_BLKSIZE_SHIFT 0
0163 #define MT_ST_BLKSIZE_MASK  0xffffff
0164 #define MT_ST_DENSITY_SHIFT 24
0165 #define MT_ST_DENSITY_MASK  0xff000000
0166
0167 #define MT_ST_SOFTERR_SHIFT 0
0168 #define MT_ST_SOFTERR_MASK  0xffff
0169
0170 /* Bitfields for the MTSETDRVBUFFER ioctl */
0171 #define MT_ST_OPTIONS       0xf0000000
0172 #define MT_ST_BOOLEANS      0x10000000
0173 #define MT_ST_SETBOOLEANS   0x30000000
0174 #define MT_ST_CLEARBOOLEANS 0x40000000
0175 #define MT_ST_WRITE_THRESHOLD   0x20000000
0176 #define MT_ST_DEF_BLKSIZE   0x50000000
0177 #define MT_ST_DEF_OPTIONS   0x60000000
0178 #define MT_ST_TIMEOUTS      0x70000000
0179 #define MT_ST_SET_TIMEOUT   (MT_ST_TIMEOUTS | 0x000000)
0180 #define MT_ST_SET_LONG_TIMEOUT  (MT_ST_TIMEOUTS | 0x100000)
0181 #define MT_ST_SET_CLN       0x80000000
0182
0183 #define MT_ST_BUFFER_WRITES 0x1
0184 #define MT_ST_ASYNC_WRITES  0x2
0185 #define MT_ST_READ_AHEAD    0x4
0186 #define MT_ST_DEBUGGING     0x8
0187 #define MT_ST_TWO_FM        0x10
0188 #define MT_ST_FAST_MTEOM    0x20
0189 #define MT_ST_AUTO_LOCK     0x40
0190 #define MT_ST_DEF_WRITES    0x80
0191 #define MT_ST_CAN_BSR       0x100
0192 #define MT_ST_NO_BLKLIMS    0x200
0193 #define MT_ST_CAN_PARTITIONS    0x400
0194 #define MT_ST_SCSI2LOGICAL      0x800
0195 #define MT_ST_SYSV              0x1000
0196 #define MT_ST_NOWAIT            0x2000
0197 #define MT_ST_SILI      0x4000
0198 #define MT_ST_NOWAIT_EOF    0x8000
0199
0200 /* The mode parameters to be controlled. Parameter chosen with bits 20-28 */
0201 #define MT_ST_CLEAR_DEFAULT 0xfffff
0202 #define MT_ST_DEF_DENSITY   (MT_ST_DEF_OPTIONS | 0x100000)
0203 #define MT_ST_DEF_COMPRESSION   (MT_ST_DEF_OPTIONS | 0x200000)
0204 #define MT_ST_DEF_DRVBUFFER (MT_ST_DEF_OPTIONS | 0x300000)
0205
0206 /* The offset for the arguments for the special HP changer load command. */
0207 #define MT_ST_HPLOADER_OFFSET 10000
0208
0209 #endif /* _LINUX_MTIO_H */