1 /* Structures and definitions for magnetic tape I/O control commands. 2 Copyright (C) 1996, 1997 Free Software Foundation, Inc. 3 This file is part of the GNU C Library. 4 5 The GNU C Library is free software; you can redistribute it and/or 6 modify it under the terms of the GNU Lesser General Public 7 License as published by the Free Software Foundation; either 8 version 2.1 of the License, or (at your option) any later version. 9 10 The GNU C Library is distributed in the hope that it will be useful, 11 but WITHOUT ANY WARRANTY; without even the implied warranty of 12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 13 Lesser General Public License for more details. 14 15 You should have received a copy of the GNU Lesser General Public 16 License along with the GNU C Library; if not, write to the Free 17 Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 18 02111-1307 USA. */ 19 20 /* Written by H. Bergman <hennus@cybercomm.nl>. */ 21 22 #ifndef _SYS_MTIO_H 23 #define _SYS_MTIO_H 1 24 25 /* Get necessary definitions from system and kernel headers. */ 26 #include <sys/types.h> 27 #include <sys/ioctl.h> 28 29 30 /* Structure for MTIOCTOP - magnetic tape operation command. */ 31 struct mtop 32 { 33 short int mt_op; /* Operations defined below. */ 34 int mt_count; /* How many of them. */ 35 }; 36 #define _IOT_mtop /* Hurd ioctl type field. */ \ 37 _IOT (_IOTS (short), 1, _IOTS (int), 1, 0, 0) 38 39 /* Magnetic Tape operations [Not all operations supported by all drivers]. */ 40 #define MTRESET 0 /* +reset drive in case of problems. */ 41 #define MTFSF 1 /* Forward space over FileMark, 42 * position at first record of next file. */ 43 #define MTBSF 2 /* Backward space FileMark (position before FM). */ 44 #define MTFSR 3 /* Forward space record. */ 45 #define MTBSR 4 /* Backward space record. */ 46 #define MTWEOF 5 /* Write an end-of-file record (mark). */ 47 #define MTREW 6 /* Rewind. */ 48 #define MTOFFL 7 /* Rewind and put the drive offline (eject?). */ 49 #define MTNOP 8 /* No op, set status only (read with MTIOCGET). */ 50 #define MTRETEN 9 /* Retension tape. */ 51 #define MTBSFM 10 /* +backward space FileMark, position at FM. */ 52 #define MTFSFM 11 /* +forward space FileMark, position at FM. */ 53 #define MTEOM 12 /* Goto end of recorded media (for appending files). 54 MTEOM positions after the last FM, ready for 55 appending another file. */ 56 #define MTERASE 13 /* Erase tape -- be careful! */ 57 58 #define MTRAS1 14 /* Run self test 1 (nondestructive). */ 59 #define MTRAS2 15 /* Run self test 2 (destructive). */ 60 #define MTRAS3 16 /* Reserved for self test 3. */ 61 62 #define MTSETBLK 20 /* Set block length (SCSI). */ 63 #define MTSETDENSITY 21 /* Set tape density (SCSI). */ 64 #define MTSEEK 22 /* Seek to block (Tandberg, etc.). */ 65 #define MTTELL 23 /* Tell block (Tandberg, etc.). */ 66 #define MTSETDRVBUFFER 24 /* Set the drive buffering according to SCSI-2. 67 Ordinary buffered operation with code 1. */ 68 #define MTFSS 25 /* Space forward over setmarks. */ 69 #define MTBSS 26 /* Space backward over setmarks. */ 70 #define MTWSM 27 /* Write setmarks. */ 71 72 #define MTLOCK 28 /* Lock the drive door. */ 73 #define MTUNLOCK 29 /* Unlock the drive door. */ 74 #define MTLOAD 30 /* Execute the SCSI load command. */ 75 #define MTUNLOAD 31 /* Execute the SCSI unload command. */ 76 #define MTCOMPRESSION 32/* Control compression with SCSI mode page 15. */ 77 #define MTSETPART 33 /* Change the active tape partition. */ 78 #define MTMKPART 34 /* Format the tape with one or two partitions. */ 79 80 /* structure for MTIOCGET - mag tape get status command */ 81 82 struct mtget 83 { 84 long int mt_type; /* Type of magtape device. */ 85 long int mt_resid; /* Residual count: (not sure) 86 number of bytes ignored, or 87 number of files not skipped, or 88 number of records not skipped. */ 89 /* The following registers are device dependent. */ 90 long int mt_dsreg; /* Status register. */ 91 long int mt_gstat; /* Generic (device independent) status. */ 92 long int mt_erreg; /* Error register. */ 93 /* The next two fields are not always used. */ 94 __daddr_t mt_fileno; /* Number of current file on tape. */ 95 __daddr_t mt_blkno; /* Current block number. */ 96 }; 97 #define _IOT_mtget /* Hurd ioctl type field. */ \ 98 _IOT (_IOTS (long), 7, 0, 0, 0, 0) 99 100 101 /* Constants for mt_type. Not all of these are supported, and 102 these are not all of the ones that are supported. */ 103 #define MT_ISUNKNOWN 0x01 104 #define MT_ISQIC02 0x02 /* Generic QIC-02 tape streamer. */ 105 #define MT_ISWT5150 0x03 /* Wangtek 5150EQ, QIC-150, QIC-02. */ 106 #define MT_ISARCHIVE_5945L2 0x04 /* Archive 5945L-2, QIC-24, QIC-02?. */ 107 #define MT_ISCMSJ500 0x05 /* CMS Jumbo 500 (QIC-02?). */ 108 #define MT_ISTDC3610 0x06 /* Tandberg 6310, QIC-24. */ 109 #define MT_ISARCHIVE_VP60I 0x07 /* Archive VP60i, QIC-02. */ 110 #define MT_ISARCHIVE_2150L 0x08 /* Archive Viper 2150L. */ 111 #define MT_ISARCHIVE_2060L 0x09 /* Archive Viper 2060L. */ 112 #define MT_ISARCHIVESC499 0x0A /* Archive SC-499 QIC-36 controller. */ 113 #define MT_ISQIC02_ALL_FEATURES 0x0F /* Generic QIC-02 with all features. */ 114 #define MT_ISWT5099EEN24 0x11 /* Wangtek 5099-een24, 60MB, QIC-24. */ 115 #define MT_ISTEAC_MT2ST 0x12 /* Teac MT-2ST 155mb drive, 116 Teac DC-1 card (Wangtek type). */ 117 #define MT_ISEVEREX_FT40A 0x32 /* Everex FT40A (QIC-40). */ 118 #define MT_ISDDS1 0x51 /* DDS device without partitions. */ 119 #define MT_ISDDS2 0x52 /* DDS device with partitions. */ 120 #define MT_ISSCSI1 0x71 /* Generic ANSI SCSI-1 tape unit. */ 121 #define MT_ISSCSI2 0x72 /* Generic ANSI SCSI-2 tape unit. */ 122 123 /* QIC-40/80/3010/3020 ftape supported drives. 124 20bit vendor ID + 0x800000 (see vendors.h in ftape distribution). */ 125 #define MT_ISFTAPE_UNKNOWN 0x800000 /* obsolete */ 126 #define MT_ISFTAPE_FLAG 0x800000 127 128 struct mt_tape_info 129 { 130 long int t_type; /* Device type id (mt_type). */ 131 char *t_name; /* Descriptive name. */ 132 }; 133 134 #define MT_TAPE_INFO \ 135 { \ 136 {MT_ISUNKNOWN, "Unknown type of tape device"}, \ 137 {MT_ISQIC02, "Generic QIC-02 tape streamer"}, \ 138 {MT_ISWT5150, "Wangtek 5150, QIC-150"}, \ 139 {MT_ISARCHIVE_5945L2, "Archive 5945L-2"}, \ 140 {MT_ISCMSJ500, "CMS Jumbo 500"}, \ 141 {MT_ISTDC3610, "Tandberg TDC 3610, QIC-24"}, \ 142 {MT_ISARCHIVE_VP60I, "Archive VP60i, QIC-02"}, \ 143 {MT_ISARCHIVE_2150L, "Archive Viper 2150L"}, \ 144 {MT_ISARCHIVE_2060L, "Archive Viper 2060L"}, \ 145 {MT_ISARCHIVESC499, "Archive SC-499 QIC-36 controller"}, \ 146 {MT_ISQIC02_ALL_FEATURES, "Generic QIC-02 tape, all features"}, \ 147 {MT_ISWT5099EEN24, "Wangtek 5099-een24, 60MB"}, \ 148 {MT_ISTEAC_MT2ST, "Teac MT-2ST 155mb data cassette drive"}, \ 149 {MT_ISEVEREX_FT40A, "Everex FT40A, QIC-40"}, \ 150 {MT_ISSCSI1, "Generic SCSI-1 tape"}, \ 151 {MT_ISSCSI2, "Generic SCSI-2 tape"}, \ 152 {0, NULL} \ 153 } 154 155 156 /* Structure for MTIOCPOS - mag tape get position command. */ 157 158 struct mtpos 159 { 160 long int mt_blkno; /* Current block number. */ 161 }; 162 #define _IOT_mtpos /* Hurd ioctl type field. */ \ 163 _IOT_SIMPLE (long) 164 165 166 /* Structure for MTIOCGETCONFIG/MTIOCSETCONFIG primarily intended 167 as an interim solution for QIC-02 until DDI is fully implemented. */ 168 struct mtconfiginfo 169 { 170 long int mt_type; /* Drive type. */ 171 long int ifc_type; /* Interface card type. */ 172 unsigned short int irqnr; /* IRQ number to use. */ 173 unsigned short int dmanr; /* DMA channel to use. */ 174 unsigned short int port; /* IO port base address. */ 175 176 unsigned long int debug; /* Debugging flags. */ 177 178 unsigned have_dens:1; 179 unsigned have_bsf:1; 180 unsigned have_fsr:1; 181 unsigned have_bsr:1; 182 unsigned have_eod:1; 183 unsigned have_seek:1; 184 unsigned have_tell:1; 185 unsigned have_ras1:1; 186 unsigned have_ras2:1; 187 unsigned have_ras3:1; 188 unsigned have_qfa:1; 189 190 unsigned pad1:5; 191 char reserved[10]; 192 }; 193 #define _IOT_mtconfiginfo /* Hurd ioctl type field. */ \ 194 _IOT (_IOTS (long), 2, _IOTS (short), 3, _IOTS (long), 1) /* XXX wrong */ 195 196 197 /* Magnetic tape I/O control commands. */ 198 #define MTIOCTOP _IOW('m', 1, struct mtop) /* Do a mag tape op. */ 199 #define MTIOCGET _IOR('m', 2, struct mtget) /* Get tape status. */ 200 #define MTIOCPOS _IOR('m', 3, struct mtpos) /* Get tape position.*/ 201 202 /* The next two are used by the QIC-02 driver for runtime reconfiguration. 203 See tpqic02.h for struct mtconfiginfo. */ 204 #define MTIOCGETCONFIG _IOR('m', 4, struct mtconfiginfo) /* Get tape config.*/ 205 #define MTIOCSETCONFIG _IOW('m', 5, struct mtconfiginfo) /* Set tape config.*/ 206 207 /* Generic Mag Tape (device independent) status macros for examining 208 mt_gstat -- HP-UX compatible. 209 There is room for more generic status bits here, but I don't 210 know which of them are reserved. At least three or so should 211 be added to make this really useful. */ 212 #define GMT_EOF(x) ((x) & 0x80000000) 213 #define GMT_BOT(x) ((x) & 0x40000000) 214 #define GMT_EOT(x) ((x) & 0x20000000) 215 #define GMT_SM(x) ((x) & 0x10000000) /* DDS setmark */ 216 #define GMT_EOD(x) ((x) & 0x08000000) /* DDS EOD */ 217 #define GMT_WR_PROT(x) ((x) & 0x04000000) 218 /* #define GMT_ ? ((x) & 0x02000000) */ 219 #define GMT_ONLINE(x) ((x) & 0x01000000) 220 #define GMT_D_6250(x) ((x) & 0x00800000) 221 #define GMT_D_1600(x) ((x) & 0x00400000) 222 #define GMT_D_800(x) ((x) & 0x00200000) 223 /* #define GMT_ ? ((x) & 0x00100000) */ 224 /* #define GMT_ ? ((x) & 0x00080000) */ 225 #define GMT_DR_OPEN(x) ((x) & 0x00040000) /* Door open (no tape). */ 226 /* #define GMT_ ? ((x) & 0x00020000) */ 227 #define GMT_IM_REP_EN(x) ((x) & 0x00010000) /* Immediate report mode.*/ 228 /* 16 generic status bits unused. */ 229 230 231 /* SCSI-tape specific definitions. Bitfield shifts in the status */ 232 #define MT_ST_BLKSIZE_SHIFT 0 233 #define MT_ST_BLKSIZE_MASK 0xffffff 234 #define MT_ST_DENSITY_SHIFT 24 235 #define MT_ST_DENSITY_MASK 0xff000000 236 237 #define MT_ST_SOFTERR_SHIFT 0 238 #define MT_ST_SOFTERR_MASK 0xffff 239 240 /* Bitfields for the MTSETDRVBUFFER ioctl. */ 241 #define MT_ST_OPTIONS 0xf0000000 242 #define MT_ST_BOOLEANS 0x10000000 243 #define MT_ST_SETBOOLEANS 0x30000000 244 #define MT_ST_CLEARBOOLEANS 0x40000000 245 #define MT_ST_WRITE_THRESHOLD 0x20000000 246 #define MT_ST_DEF_BLKSIZE 0x50000000 247 #define MT_ST_DEF_OPTIONS 0x60000000 248 249 #define MT_ST_BUFFER_WRITES 0x1 250 #define MT_ST_ASYNC_WRITES 0x2 251 #define MT_ST_READ_AHEAD 0x4 252 #define MT_ST_DEBUGGING 0x8 253 #define MT_ST_TWO_FM 0x10 254 #define MT_ST_FAST_MTEOM 0x20 255 #define MT_ST_AUTO_LOCK 0x40 256 #define MT_ST_DEF_WRITES 0x80 257 #define MT_ST_CAN_BSR 0x100 258 #define MT_ST_NO_BLKLIMS 0x200 259 #define MT_ST_CAN_PARTITIONS 0x400 260 #define MT_ST_SCSI2LOGICAL 0x800 261 262 /* The mode parameters to be controlled. Parameter chosen with bits 20-28. */ 263 #define MT_ST_CLEAR_DEFAULT 0xfffff 264 #define MT_ST_DEF_DENSITY (MT_ST_DEF_OPTIONS | 0x100000) 265 #define MT_ST_DEF_COMPRESSION (MT_ST_DEF_OPTIONS | 0x200000) 266 #define MT_ST_DEF_DRVBUFFER (MT_ST_DEF_OPTIONS | 0x300000) 267 268 /* The offset for the arguments for the special HP changer load command. */ 269 #define MT_ST_HPLOADER_OFFSET 10000 270 271 272 /* Specify default tape device. */ 273 #ifndef DEFTAPE 274 # define DEFTAPE "/dev/tape" 275 #endif 276 277 #endif /* mtio.h */ 278