share/man/man4/mtio.4

   1 .\" Copyright (c) 1996
   2 .\"     Mike Pritchard <mpp@FreeBSD.org>.  All rights reserved.
   3 .\"
   4 .\" Copyright (c) 1983, 1991, 1993
   5 .\"     The Regents of the University of California.  All rights reserved.
   6 .\"
   7 .\" Redistribution and use in source and binary forms, with or without
   8 .\" modification, are permitted provided that the following conditions
   9 .\" are met:
  10 .\" 1. Redistributions of source code must retain the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer.
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in the
  14 .\"    documentation and/or other materials provided with the distribution.
  15 .\" 3. Neither the name of the University nor the names of its contributors
  16 .\"    may be used to endorse or promote products derived from this software
  17 .\"    without specific prior written permission.
  18 .\"
  19 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  20 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  23 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  25 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  26 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  27 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  28 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  29 .\" SUCH DAMAGE.
  30 .\"
  31 .\"     @(#)mtio.4      8.1 (Berkeley) 6/5/93
  32 .\" $FreeBSD$
  33 .\"
  34 .Dd February 12, 2015
  35 .Dt MTIO 4
  36 .Os
  37 .Sh NAME
  38 .Nm mtio
  39 .Nd FreeBSD magtape interface
  40 .Sh DESCRIPTION
  41 The special files
  42 named
  43 .Pa /dev/[en]sa*
  44 refer to SCSI tape drives,
  45 which may be attached to the system.
  46 .Pa /dev/sa*.ctl
  47 are control devices that can be used to issue ioctls to the SCSI
  48 tape driver to set parameters that are required to last beyond the
  49 unmounting of a tape.
  50 .Pp
  51 The rewind devices automatically rewind
  52 when the last requested read, write or seek has finished, or the end of the tape
  53 has been reached.
  54 The letter
  55 .Ql n
  56 is prepended to
  57 the name of the no-rewind devices.
  58 The letter
  59 .Ql e
  60 is prepended to the name of the eject devices.
  61 .Pp
  62 Tapes can be written with either fixed length records or variable length
  63 records.
  64 See
  65 .Xr sa 4
  66 for more information.
  67 Two filemarks mark the end of a tape, and
  68 one filemark marks the end of a tape file.
  69 If the tape is not to be rewound it is positioned with the
  70 head in between the two tape marks, where the next write
  71 will over write the second end-of-file marker.
  72 .Pp
  73 All of the magtape devices may be manipulated with the
  74 .Xr mt 1
  75 command.
  76 .Pp
  77 A number of
  78 .Xr ioctl 2
  79 operations are available
  80 on raw magnetic tape.
  81 The following definitions are from
  82 .In sys/mtio.h :
  83 .Bd  -literal
  84 #ifndef _SYS_MTIO_H_
  85 #define _SYS_MTIO_H_
  86
  87 #ifndef _KERNEL
  88 #include <sys/types.h>
  89 #endif
  90 #include <sys/ioccom.h>
  91
  92 /*
  93  * Structures and definitions for mag tape io control commands
  94  */
  95
  96 /* structure for MTIOCTOP - mag tape op command */
  97 struct mtop {
  98         short   mt_op;          /* operations defined below */
  99         int32_t mt_count;       /* how many of them */
 100 };
 101
 102 /* operations */
 103 #define MTWEOF          0       /* write an end-of-file record */
 104 #define MTFSF           1       /* forward space file */
 105 #define MTBSF           2       /* backward space file */
 106 #define MTFSR           3       /* forward space record */
 107 #define MTBSR           4       /* backward space record */
 108 #define MTREW           5       /* rewind */
 109 #define MTOFFL          6       /* rewind and put the drive offline */
 110 #define MTNOP           7       /* no operation, sets status only */
 111 #define MTCACHE         8       /* enable controller cache */
 112 #define MTNOCACHE       9       /* disable controller cache */
 113
 114 #if defined(__FreeBSD__)
 115 /* Set block size for device. If device is a variable size dev          */
 116 /* a non zero parameter will change the device to a fixed block size    */
 117 /* device with block size set to that of the parameter passed in.       */
 118 /* Resetting the block size to 0 will restore the device to a variable  */
 119 /* block size device. */
 120
 121 #define MTSETBSIZ       10
 122
 123 /* Set density values for device. Sets the value for the opened mode only. */
 124
 125 #define MTSETDNSTY      11
 126
 127 #define MTERASE         12      /* erase to EOM */
 128 #define MTEOD           13      /* Space to EOM */
 129 #define MTCOMP          14      /* select compression mode 0=off, 1=def */
 130 #define MTRETENS        15      /* re-tension tape */
 131 #define MTWSS           16      /* write setmark(s) */
 132 #define MTFSS           17      /* forward space setmark */
 133 #define MTBSS           18      /* backward space setmark */
 134 #define MTLOAD          19      /* load tape in drive */
 135 #define MTWEOFI         20      /* write an end-of-file record without waiting*/
 136
 137 #define MT_COMP_ENABLE          0xffffffff
 138 #define MT_COMP_DISABLED        0xfffffffe
 139 #define MT_COMP_UNSUPP          0xfffffffd
 140
 141 /*
 142  * Values in mt_dsreg that say what the device is doing
 143  */
 144 #define MTIO_DSREG_NIL  0       /* Unknown */
 145 #define MTIO_DSREG_REST 1       /* Doing Nothing */
 146 #define MTIO_DSREG_RBSY 2       /* Communicating with tape (but no motion) */
 147 #define MTIO_DSREG_WR   20      /* Writing */
 148 #define MTIO_DSREG_FMK  21      /* Writing Filemarks */
 149 #define MTIO_DSREG_ZER  22      /* Erasing */
 150 #define MTIO_DSREG_RD   30      /* Reading */
 151 #define MTIO_DSREG_FWD  40      /* Spacing Forward */
 152 #define MTIO_DSREG_REV  41      /* Spacing Reverse */
 153 #define MTIO_DSREG_POS  42      /* Hardware Positioning (direction unknown) */
 154 #define MTIO_DSREG_REW  43      /* Rewinding */
 155 #define MTIO_DSREG_TEN  44      /* Retensioning */
 156 #define MTIO_DSREG_UNL  45      /* Unloading */
 157 #define MTIO_DSREG_LD   46      /* Loading */
 158
 159 #endif  /* __FreeBSD__ */
 160
 161 /* structure for MTIOCGET - mag tape get status command */
 162
 163 struct mtget {
 164         short   mt_type;        /* type of magtape device */
 165 /* the following two registers are grossly device dependent */
 166         short   mt_dsreg;       /* ``drive status'' register */
 167         short   mt_erreg;       /* ``error'' register */
 168 /* end device-dependent registers */
 169         /*
 170          * Note that the residual count, while maintained, may be
 171          * be nonsense because the size of the residual may (greatly)
 172          * exceed 32 K-bytes. Use the MTIOCERRSTAT ioctl to get a
 173          * more accurate count.
 174          */
 175         short   mt_resid;       /* residual count */
 176 #if defined (__FreeBSD__)
 177         int32_t mt_blksiz;      /* presently operating blocksize */
 178         int32_t mt_density;     /* presently operating density */
 179         uint32_t mt_comp;       /* presently operating compression */
 180         int32_t mt_blksiz0;     /* blocksize for mode 0 */
 181         int32_t mt_blksiz1;     /* blocksize for mode 1 */
 182         int32_t mt_blksiz2;     /* blocksize for mode 2 */
 183         int32_t mt_blksiz3;     /* blocksize for mode 3 */
 184         int32_t mt_density0;    /* density for mode 0 */
 185         int32_t mt_density1;    /* density for mode 1 */
 186         int32_t mt_density2;    /* density for mode 2 */
 187         int32_t mt_density3;    /* density for mode 3 */
 188 /* the following are not yet implemented */
 189         uint32_t mt_comp0;      /* compression type for mode 0 */
 190         uint32_t mt_comp1;      /* compression type for mode 1 */
 191         uint32_t mt_comp2;      /* compression type for mode 2 */
 192         uint32_t mt_comp3;      /* compression type for mode 3 */
 193 /* end not yet implemented */
 194 #endif
 195         int32_t mt_fileno;      /* relative file number of current position */
 196         int32_t mt_blkno;       /* relative block number of current position */
 197 };
 198
 199 /* structure for MTIOCERRSTAT - tape get error status command */
 200 /* really only supported for SCSI tapes right now */
 201 struct scsi_tape_errors {
 202         /*
 203          * These are latched from the last command that had a SCSI
 204          * Check Condition noted for these operations. The act
 205          * of issuing an MTIOCERRSTAT unlatches and clears them.
 206          */
 207         uint8_t io_sense[32];   /* Last Sense Data For Data I/O */
 208         int32_t io_resid;       /* residual count from last Data I/O */
 209         uint8_t io_cdb[16];     /* Command that Caused the Last Data Sense */
 210         uint8_t ctl_sense[32];  /* Last Sense Data For Control I/O */
 211         int32_t ctl_resid;      /* residual count from last Control I/O */
 212         uint8_t ctl_cdb[16];    /* Command that Caused the Last Control Sense */
 213         /*
 214          * These are the read and write cumulative error counters.
 215          * (how to reset cumulative error counters is not yet defined).
 216          * (not implemented as yet but space is being reserved for them)
 217          */
 218         struct {
 219                 uint32_t retries;       /* total # retries performed */
 220                 uint32_t corrected;     /* total # corrections performed */
 221                 uint32_t processed;     /* total # corrections successful */
 222                 uint32_t failures;      /* total # corrections/retries failed */
 223                 uint64_t nbytes;        /* total # bytes processed */
 224         } wterr, rderr;
 225 };
 226
 227 union mterrstat {
 228         struct scsi_tape_errors scsi_errstat;
 229         char _reserved_padding[256];
 230 };
 231
 232 struct mtrblim {
 233         uint32_t granularity;
 234         uint32_t min_block_length;
 235         uint32_t max_block_length;
 236 };
 237
 238 typedef enum {
 239         MT_LOCATE_DEST_OBJECT   = 0x00,
 240         MT_LOCATE_DEST_FILE     = 0x01,
 241         MT_LOCATE_DEST_SET      = 0x02,
 242         MT_LOCATE_DEST_EOD      = 0x03
 243 } mt_locate_dest_type;
 244
 245 typedef enum {
 246         MT_LOCATE_BAM_IMPLICIT  = 0x00,
 247         MT_LOCATE_BAM_EXPLICIT  = 0x01
 248 } mt_locate_bam;
 249
 250 typedef enum {
 251         MT_LOCATE_FLAG_IMMED            = 0x01,
 252         MT_LOCATE_FLAG_CHANGE_PART      = 0x02
 253 } mt_locate_flags;
 254
 255 struct mtlocate {
 256         mt_locate_flags         flags;
 257         mt_locate_dest_type     dest_type;
 258         mt_locate_bam           block_address_mode;
 259         int64_t                 partition;
 260         uint64_t                logical_id;
 261         uint8_t                 reserved[64];
 262 };
 263
 264 typedef enum {
 265         MT_EXT_GET_NONE,
 266         MT_EXT_GET_OK,
 267         MT_EXT_GET_NEED_MORE_SPACE,
 268         MT_EXT_GET_ERROR
 269 } mt_ext_get_status;
 270
 271 struct mtextget {
 272         uint32_t                alloc_len;
 273         char                    *status_xml;
 274         uint32_t                fill_len;
 275         mt_ext_get_status       status;
 276         char                    error_str[128];
 277         uint8_t                 reserved[64];
 278 };
 279
 280 #define MT_EXT_GET_ROOT_NAME            "mtextget"
 281 #define MT_DENSITY_ROOT_NAME            "mtdensity"
 282 #define MT_MEDIA_DENSITY_NAME           "media_density"
 283 #define MT_DENSITY_REPORT_NAME          "density_report"
 284 #define MT_MEDIUM_TYPE_REPORT_NAME      "medium_type_report"
 285 #define MT_MEDIA_REPORT_NAME            "media_report"
 286 #define MT_DENSITY_ENTRY_NAME           "density_entry"
 287
 288 #define MT_DENS_WRITE_OK                0x80
 289 #define MT_DENS_DUP                     0x40
 290 #define MT_DENS_DEFLT                   0x20
 291
 292
 293 #define MT_PARAM_FIXED_STR_LEN  32
 294 union mt_param_value {
 295         int64_t         value_signed;
 296         uint64_t        value_unsigned;
 297         char            *value_var_str;
 298         char            value_fixed_str[MT_PARAM_FIXED_STR_LEN];
 299         uint8_t         reserved[64];
 300 };
 301
 302 typedef enum {
 303         MT_PARAM_SET_NONE,
 304         MT_PARAM_SET_SIGNED,
 305         MT_PARAM_SET_UNSIGNED,
 306         MT_PARAM_SET_VAR_STR,
 307         MT_PARAM_SET_FIXED_STR
 308 } mt_param_set_type;
 309
 310 typedef enum {
 311         MT_PARAM_STATUS_NONE,
 312         MT_PARAM_STATUS_OK,
 313         MT_PARAM_STATUS_ERROR
 314 } mt_param_set_status;
 315
 316 #define MT_PARAM_VALUE_NAME_LEN 64
 317 struct mtparamset {
 318         char                    value_name[MT_PARAM_VALUE_NAME_LEN];
 319         mt_param_set_type       value_type;
 320         int                     value_len;
 321         union mt_param_value    value;
 322         mt_param_set_status     status;
 323         char                    error_str[128];
 324 };
 325
 326 #define MT_PARAM_ROOT_NAME      "mtparamget"
 327 #define MT_PROTECTION_NAME      "protection"
 328
 329 /*
 330  * Set a list of parameters.
 331  */
 332 struct mtsetlist {
 333         int num_params;
 334         int param_len;
 335         struct mtparamset *params;
 336 };
 337
 338 /*
 339  * Constants for mt_type byte.  These are the same
 340  * for controllers compatible with the types listed.
 341  */
 342 #define MT_ISTS         0x01            /* TS-11 */
 343 #define MT_ISHT         0x02            /* TM03 Massbus: TE16, TU45, TU77 */
 344 #define MT_ISTM         0x03            /* TM11/TE10 Unibus */
 345 #define MT_ISMT         0x04            /* TM78/TU78 Massbus */
 346 #define MT_ISUT         0x05            /* SI TU-45 emulation on Unibus */
 347 #define MT_ISCPC        0x06            /* SUN */
 348 #define MT_ISAR         0x07            /* SUN */
 349 #define MT_ISTMSCP      0x08            /* DEC TMSCP protocol (TU81, TK50) */
 350 #define MT_ISCY         0x09            /* CCI Cipher */
 351 #define MT_ISCT         0x0a            /* HP 1/4 tape */
 352 #define MT_ISFHP        0x0b            /* HP 7980 1/2 tape */
 353 #define MT_ISEXABYTE    0x0c            /* Exabyte */
 354 #define MT_ISEXA8200    0x0c            /* Exabyte EXB-8200 */
 355 #define MT_ISEXA8500    0x0d            /* Exabyte EXB-8500 */
 356 #define MT_ISVIPER1     0x0e            /* Archive Viper-150 */
 357 #define MT_ISPYTHON     0x0f            /* Archive Python (DAT) */
 358 #define MT_ISHPDAT      0x10            /* HP 35450A DAT drive */
 359 #define MT_ISMFOUR      0x11            /* M4 Data 1/2 9track drive */
 360 #define MT_ISTK50       0x12            /* DEC SCSI TK50 */
 361 #define MT_ISMT02       0x13            /* Emulex MT02 SCSI tape controller */
 362
 363 /* mag tape io control commands */
 364 #define MTIOCTOP        _IOW('m', 1, struct mtop)       /* do a mag tape op */
 365 #define MTIOCGET        _IOR('m', 2, struct mtget)      /* get tape status */
 366 /* these two do not appear to be used anywhere */
 367 #define MTIOCIEOT       _IO('m', 3)                     /* ignore EOT error */
 368 #define MTIOCEEOT       _IO('m', 4)                     /* enable EOT error */
 369 /*
 370  * When more SCSI-3 SSC (streaming device) devices are out there
 371  * that support the full 32 byte type 2 structure, we'll have to
 372  * rethink these ioctls to support all the entities they haul into
 373  * the picture (64 bit blocks, logical file record numbers, etc..).
 374  */
 375 #define MTIOCRDSPOS     _IOR('m', 5, uint32_t)  /* get logical blk addr */
 376 #define MTIOCRDHPOS     _IOR('m', 6, uint32_t)  /* get hardware blk addr */
 377 #define MTIOCSLOCATE    _IOW('m', 5, uint32_t)  /* seek to logical blk addr */
 378 #define MTIOCHLOCATE    _IOW('m', 6, uint32_t)  /* seek to hardware blk addr */
 379 #define MTIOCERRSTAT    _IOR('m', 7, union mterrstat)   /* get tape errors */
 380 /*
 381  * Set EOT model- argument is number of filemarks to end a tape with.
 382  * Note that not all possible values will be accepted.
 383  */
 384 #define MTIOCSETEOTMODEL        _IOW('m', 8, uint32_t)
 385 /* Get current EOT model */
 386 #define MTIOCGETEOTMODEL        _IOR('m', 8, uint32_t)
 387 #define MTIOCRBLIM      _IOR('m', 9, struct mtrblim)    /* get block limits */
 388 #define MTIOCEXTLOCATE  _IOW('m', 10, struct mtlocate)  /* seek to position */
 389 #define MTIOCEXTGET     _IOWR('m', 11, struct mtextget) /* get tape status */
 390 #define MTIOCPARAMGET   _IOWR('m', 12, struct mtextget) /* get tape params */
 391 #define MTIOCPARAMSET   _IOWR('m', 13, struct mtparamset) /* set tape params */
 392 #define MTIOCSETLIST    _IOWR('m', 14, struct mtsetlist) /* set N params */
 393
 394 #ifndef _KERNEL
 395 #define DEFTAPE "/dev/nsa0"
 396 #endif
 397
 398 #endif /* !_SYS_MTIO_H_ */
 399 .Ed
 400 .Sh FILES
 401 .Bl -tag -width /dev/[en]sa* -compact
 402 .It Pa /dev/[en]sa*
 403 .El
 404 .Sh SEE ALSO
 405 .Xr mt 1 ,
 406 .Xr tar 1 ,
 407 .Xr sa 4
 408 .Sh HISTORY
 409 The
 410 .Nm
 411 manual appeared in
 412 .Bx 4.2 .
 413 An i386 version first appeared in
 414 .Fx 2.2 .