Home | History | Annotate | Download | only in linux
      1 /*
      2  * linux/mtio.h header file for Linux. Written by H. Bergman
      3  *
      4  * Modified for special ioctls provided by zftape in September 1997
      5  * by C.-J. Heine.
      6  */
      7 
      8 #ifndef _LINUX_MTIO_H
      9 #define _LINUX_MTIO_H
     10 
     11 #include <linux/types.h>
     12 #include <linux/ioctl.h>
     13 
     14 /*
     15  * Structures and definitions for mag tape io control commands
     16  */
     17 
     18 /* structure for MTIOCTOP - mag tape op command */
     19 struct	mtop {
     20 	short	mt_op;		/* operations defined below */
     21 	int	mt_count;	/* how many of them */
     22 };
     23 
     24 /* Magnetic Tape operations [Not all operations supported by all drivers]: */
     25 #define MTRESET 0	/* +reset drive in case of problems */
     26 #define MTFSF	1	/* forward space over FileMark,
     27 			 * position at first record of next file
     28 			 */
     29 #define MTBSF	2	/* backward space FileMark (position before FM) */
     30 #define MTFSR	3	/* forward space record */
     31 #define MTBSR	4	/* backward space record */
     32 #define MTWEOF	5	/* write an end-of-file record (mark) */
     33 #define MTREW	6	/* rewind */
     34 #define MTOFFL	7	/* rewind and put the drive offline (eject?) */
     35 #define MTNOP	8	/* no op, set status only (read with MTIOCGET) */
     36 #define MTRETEN 9	/* retension tape */
     37 #define MTBSFM	10	/* +backward space FileMark, position at FM */
     38 #define MTFSFM  11	/* +forward space FileMark, position at FM */
     39 #define MTEOM	12	/* goto end of recorded media (for appending files).
     40 			 * MTEOM positions after the last FM, ready for
     41 			 * appending another file.
     42 			 */
     43 #define MTERASE 13	/* erase tape -- be careful! */
     44 
     45 #define MTRAS1  14	/* run self test 1 (nondestructive) */
     46 #define MTRAS2	15	/* run self test 2 (destructive) */
     47 #define MTRAS3  16	/* reserved for self test 3 */
     48 
     49 #define MTSETBLK 20	/* set block length (SCSI) */
     50 #define MTSETDENSITY 21	/* set tape density (SCSI) */
     51 #define MTSEEK	22	/* seek to block (Tandberg, etc.) */
     52 #define MTTELL	23	/* tell block (Tandberg, etc.) */
     53 #define MTSETDRVBUFFER 24 /* set the drive buffering according to SCSI-2 */
     54 			/* ordinary buffered operation with code 1 */
     55 #define MTFSS	25	/* space forward over setmarks */
     56 #define MTBSS	26	/* space backward over setmarks */
     57 #define MTWSM	27	/* write setmarks */
     58 
     59 #define MTLOCK  28	/* lock the drive door */
     60 #define MTUNLOCK 29	/* unlock the drive door */
     61 #define MTLOAD  30	/* execute the SCSI load command */
     62 #define MTUNLOAD 31	/* execute the SCSI unload command */
     63 #define MTCOMPRESSION 32/* control compression with SCSI mode page 15 */
     64 #define MTSETPART 33	/* Change the active tape partition */
     65 #define MTMKPART  34	/* Format the tape with one or two partitions */
     66 #define MTWEOFI	35	/* write an end-of-file record (mark) in immediate mode */
     67 
     68 /* structure for MTIOCGET - mag tape get status command */
     69 
     70 struct	mtget {
     71 	long	mt_type;	/* type of magtape device */
     72 	long	mt_resid;	/* residual count: (not sure)
     73 				 *	number of bytes ignored, or
     74 				 *	number of files not skipped, or
     75 				 *	number of records not skipped.
     76 				 */
     77 	/* the following registers are device dependent */
     78 	long	mt_dsreg;	/* status register */
     79 	long	mt_gstat;	/* generic (device independent) status */
     80 	long	mt_erreg;	/* error register */
     81 	/* The next two fields are not always used */
     82 	__kernel_daddr_t mt_fileno;	/* number of current file on tape */
     83 	__kernel_daddr_t mt_blkno;	/* current block number */
     84 };
     85 
     86 
     87 
     88 /*
     89  * Constants for mt_type. Not all of these are supported,
     90  * and these are not all of the ones that are supported.
     91  */
     92 #define MT_ISUNKNOWN		0x01
     93 #define MT_ISQIC02		0x02	/* Generic QIC-02 tape streamer */
     94 #define MT_ISWT5150		0x03	/* Wangtek 5150EQ, QIC-150, QIC-02 */
     95 #define MT_ISARCHIVE_5945L2	0x04	/* Archive 5945L-2, QIC-24, QIC-02? */
     96 #define MT_ISCMSJ500		0x05	/* CMS Jumbo 500 (QIC-02?) */
     97 #define MT_ISTDC3610		0x06	/* Tandberg 6310, QIC-24 */
     98 #define MT_ISARCHIVE_VP60I	0x07	/* Archive VP60i, QIC-02 */
     99 #define MT_ISARCHIVE_2150L	0x08	/* Archive Viper 2150L */
    100 #define MT_ISARCHIVE_2060L	0x09	/* Archive Viper 2060L */
    101 #define MT_ISARCHIVESC499	0x0A	/* Archive SC-499 QIC-36 controller */
    102 #define MT_ISQIC02_ALL_FEATURES	0x0F	/* Generic QIC-02 with all features */
    103 #define MT_ISWT5099EEN24	0x11	/* Wangtek 5099-een24, 60MB, QIC-24 */
    104 #define MT_ISTEAC_MT2ST		0x12	/* Teac MT-2ST 155mb drive, Teac DC-1 card (Wangtek type) */
    105 #define MT_ISEVEREX_FT40A	0x32	/* Everex FT40A (QIC-40) */
    106 #define MT_ISDDS1		0x51	/* DDS device without partitions */
    107 #define MT_ISDDS2		0x52	/* DDS device with partitions */
    108 #define MT_ISONSTREAM_SC        0x61   /* OnStream SCSI tape drives (SC-x0)
    109 					  and SCSI emulated (DI, DP, USB) */
    110 #define MT_ISSCSI1		0x71	/* Generic ANSI SCSI-1 tape unit */
    111 #define MT_ISSCSI2		0x72	/* Generic ANSI SCSI-2 tape unit */
    112 
    113 /* QIC-40/80/3010/3020 ftape supported drives.
    114  * 20bit vendor ID + 0x800000 (see ftape-vendors.h)
    115  */
    116 #define MT_ISFTAPE_UNKNOWN	0x800000 /* obsolete */
    117 #define MT_ISFTAPE_FLAG	0x800000
    118 
    119 
    120 /* structure for MTIOCPOS - mag tape get position command */
    121 
    122 struct	mtpos {
    123 	long 	mt_blkno;	/* current block number */
    124 };
    125 
    126 
    127 /* mag tape io control commands */
    128 #define	MTIOCTOP	_IOW('m', 1, struct mtop)	/* do a mag tape op */
    129 #define	MTIOCGET	_IOR('m', 2, struct mtget)	/* get tape status */
    130 #define	MTIOCPOS	_IOR('m', 3, struct mtpos)	/* get tape position */
    131 
    132 
    133 /* Generic Mag Tape (device independent) status macros for examining
    134  * mt_gstat -- HP-UX compatible.
    135  * There is room for more generic status bits here, but I don't
    136  * know which of them are reserved. At least three or so should
    137  * be added to make this really useful.
    138  */
    139 #define GMT_EOF(x)              ((x) & 0x80000000)
    140 #define GMT_BOT(x)              ((x) & 0x40000000)
    141 #define GMT_EOT(x)              ((x) & 0x20000000)
    142 #define GMT_SM(x)               ((x) & 0x10000000)  /* DDS setmark */
    143 #define GMT_EOD(x)              ((x) & 0x08000000)  /* DDS EOD */
    144 #define GMT_WR_PROT(x)          ((x) & 0x04000000)
    145 /* #define GMT_ ? 		((x) & 0x02000000) */
    146 #define GMT_ONLINE(x)           ((x) & 0x01000000)
    147 #define GMT_D_6250(x)           ((x) & 0x00800000)
    148 #define GMT_D_1600(x)           ((x) & 0x00400000)
    149 #define GMT_D_800(x)            ((x) & 0x00200000)
    150 /* #define GMT_ ? 		((x) & 0x00100000) */
    151 /* #define GMT_ ? 		((x) & 0x00080000) */
    152 #define GMT_DR_OPEN(x)          ((x) & 0x00040000)  /* door open (no tape) */
    153 /* #define GMT_ ? 		((x) & 0x00020000) */
    154 #define GMT_IM_REP_EN(x)        ((x) & 0x00010000)  /* immediate report mode */
    155 #define GMT_CLN(x)              ((x) & 0x00008000)  /* cleaning requested */
    156 /* 15 generic status bits unused */
    157 
    158 
    159 /* SCSI-tape specific definitions */
    160 /* Bitfield shifts in the status  */
    161 #define MT_ST_BLKSIZE_SHIFT	0
    162 #define MT_ST_BLKSIZE_MASK	0xffffff
    163 #define MT_ST_DENSITY_SHIFT	24
    164 #define MT_ST_DENSITY_MASK	0xff000000
    165 
    166 #define MT_ST_SOFTERR_SHIFT	0
    167 #define MT_ST_SOFTERR_MASK	0xffff
    168 
    169 /* Bitfields for the MTSETDRVBUFFER ioctl */
    170 #define MT_ST_OPTIONS		0xf0000000
    171 #define MT_ST_BOOLEANS		0x10000000
    172 #define MT_ST_SETBOOLEANS	0x30000000
    173 #define MT_ST_CLEARBOOLEANS	0x40000000
    174 #define MT_ST_WRITE_THRESHOLD	0x20000000
    175 #define MT_ST_DEF_BLKSIZE	0x50000000
    176 #define MT_ST_DEF_OPTIONS	0x60000000
    177 #define MT_ST_TIMEOUTS		0x70000000
    178 #define MT_ST_SET_TIMEOUT	(MT_ST_TIMEOUTS | 0x000000)
    179 #define MT_ST_SET_LONG_TIMEOUT	(MT_ST_TIMEOUTS | 0x100000)
    180 #define MT_ST_SET_CLN		0x80000000
    181 
    182 #define MT_ST_BUFFER_WRITES	0x1
    183 #define MT_ST_ASYNC_WRITES	0x2
    184 #define MT_ST_READ_AHEAD	0x4
    185 #define MT_ST_DEBUGGING		0x8
    186 #define MT_ST_TWO_FM		0x10
    187 #define MT_ST_FAST_MTEOM	0x20
    188 #define MT_ST_AUTO_LOCK		0x40
    189 #define MT_ST_DEF_WRITES	0x80
    190 #define MT_ST_CAN_BSR		0x100
    191 #define MT_ST_NO_BLKLIMS	0x200
    192 #define MT_ST_CAN_PARTITIONS    0x400
    193 #define MT_ST_SCSI2LOGICAL      0x800
    194 #define MT_ST_SYSV              0x1000
    195 #define MT_ST_NOWAIT            0x2000
    196 #define MT_ST_SILI		0x4000
    197 #define MT_ST_NOWAIT_EOF	0x8000
    198 
    199 /* The mode parameters to be controlled. Parameter chosen with bits 20-28 */
    200 #define MT_ST_CLEAR_DEFAULT	0xfffff
    201 #define MT_ST_DEF_DENSITY	(MT_ST_DEF_OPTIONS | 0x100000)
    202 #define MT_ST_DEF_COMPRESSION	(MT_ST_DEF_OPTIONS | 0x200000)
    203 #define MT_ST_DEF_DRVBUFFER	(MT_ST_DEF_OPTIONS | 0x300000)
    204 
    205 /* The offset for the arguments for the special HP changer load command. */
    206 #define MT_ST_HPLOADER_OFFSET 10000
    207 
    208 #endif /* _LINUX_MTIO_H */
    209