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