sysdeps/gnu/sys/mtio.h

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