mtio.h
上传用户:jlfgdled
上传日期:2013-04-10
资源大小:33168k
文件大小:14k
源码类别:

Linux/Unix编程

开发平台:

Unix_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. #ifndef _LINUX_MTIO_H
  8. #define _LINUX_MTIO_H
  9. #include <linux/types.h>
  10. #include <linux/ioctl.h>
  11. #include <linux/qic117.h>
  12. /*
  13.  * Structures and definitions for mag tape io control commands
  14.  */
  15. /* structure for MTIOCTOP - mag tape op command */
  16. struct mtop {
  17. short mt_op; /* operations defined below */
  18. int mt_count; /* how many of them */
  19. };
  20. /* Magnetic Tape operations [Not all operations supported by all drivers]: */
  21. #define MTRESET 0 /* +reset drive in case of problems */
  22. #define MTFSF 1 /* forward space over FileMark,
  23.  * position at first record of next file 
  24.  */
  25. #define MTBSF 2 /* backward space FileMark (position before FM) */
  26. #define MTFSR 3 /* forward space record */
  27. #define MTBSR 4 /* backward space record */
  28. #define MTWEOF 5 /* write an end-of-file record (mark) */
  29. #define MTREW 6 /* rewind */
  30. #define MTOFFL 7 /* rewind and put the drive offline (eject?) */
  31. #define MTNOP 8 /* no op, set status only (read with MTIOCGET) */
  32. #define MTRETEN 9 /* retension tape */
  33. #define MTBSFM 10 /* +backward space FileMark, position at FM */
  34. #define MTFSFM  11 /* +forward space FileMark, position at FM */
  35. #define MTEOM 12 /* goto end of recorded media (for appending files).
  36.  * MTEOM positions after the last FM, ready for
  37.  * appending another file.
  38.  */
  39. #define MTERASE 13 /* erase tape -- be careful! */
  40. #define MTRAS1  14 /* run self test 1 (nondestructive) */
  41. #define MTRAS2 15 /* run self test 2 (destructive) */
  42. #define MTRAS3  16 /* reserved for self test 3 */
  43. #define MTSETBLK 20 /* set block length (SCSI) */
  44. #define MTSETDENSITY 21 /* set tape density (SCSI) */
  45. #define MTSEEK 22 /* seek to block (Tandberg, etc.) */
  46. #define MTTELL 23 /* tell block (Tandberg, etc.) */
  47. #define MTSETDRVBUFFER 24 /* set the drive buffering according to SCSI-2 */
  48. /* ordinary buffered operation with code 1 */
  49. #define MTFSS 25 /* space forward over setmarks */
  50. #define MTBSS 26 /* space backward over setmarks */
  51. #define MTWSM 27 /* write setmarks */
  52. #define MTLOCK  28 /* lock the drive door */
  53. #define MTUNLOCK 29 /* unlock the drive door */
  54. #define MTLOAD  30 /* execute the SCSI load command */
  55. #define MTUNLOAD 31 /* execute the SCSI unload command */
  56. #define MTCOMPRESSION 32/* control compression with SCSI mode page 15 */
  57. #define MTSETPART 33 /* Change the active tape partition */
  58. #define MTMKPART  34 /* Format the tape with one or two partitions */
  59. /* structure for MTIOCGET - mag tape get status command */
  60. struct mtget {
  61. long mt_type; /* type of magtape device */
  62. long mt_resid; /* residual count: (not sure)
  63.  * number of bytes ignored, or
  64.  * number of files not skipped, or
  65.  * number of records not skipped.
  66.  */
  67. /* the following registers are device dependent */
  68. long mt_dsreg; /* status register */
  69. long mt_gstat; /* generic (device independent) status */
  70. long mt_erreg; /* error register */
  71. /* The next two fields are not always used */
  72. __kernel_daddr_t mt_fileno; /* number of current file on tape */
  73. __kernel_daddr_t mt_blkno; /* current block number */
  74. };
  75. /*
  76.  * Constants for mt_type. Not all of these are supported,
  77.  * and these are not all of the ones that are supported.
  78.  */
  79. #define MT_ISUNKNOWN 0x01
  80. #define MT_ISQIC02 0x02 /* Generic QIC-02 tape streamer */
  81. #define MT_ISWT5150 0x03 /* Wangtek 5150EQ, QIC-150, QIC-02 */
  82. #define MT_ISARCHIVE_5945L2 0x04 /* Archive 5945L-2, QIC-24, QIC-02? */
  83. #define MT_ISCMSJ500 0x05 /* CMS Jumbo 500 (QIC-02?) */
  84. #define MT_ISTDC3610 0x06 /* Tandberg 6310, QIC-24 */
  85. #define MT_ISARCHIVE_VP60I 0x07 /* Archive VP60i, QIC-02 */
  86. #define MT_ISARCHIVE_2150L 0x08 /* Archive Viper 2150L */
  87. #define MT_ISARCHIVE_2060L 0x09 /* Archive Viper 2060L */
  88. #define MT_ISARCHIVESC499 0x0A /* Archive SC-499 QIC-36 controller */
  89. #define MT_ISQIC02_ALL_FEATURES 0x0F /* Generic QIC-02 with all features */
  90. #define MT_ISWT5099EEN24 0x11 /* Wangtek 5099-een24, 60MB, QIC-24 */
  91. #define MT_ISTEAC_MT2ST 0x12 /* Teac MT-2ST 155mb drive, Teac DC-1 card (Wangtek type) */
  92. #define MT_ISEVEREX_FT40A 0x32 /* Everex FT40A (QIC-40) */
  93. #define MT_ISDDS1 0x51 /* DDS device without partitions */
  94. #define MT_ISDDS2 0x52 /* DDS device with partitions */
  95. #define MT_ISONSTREAM_SC        0x61   /* OnStream SCSI tape drives (SC-x0)
  96.   and SCSI emulated (DI, DP, USB) */
  97. #define MT_ISSCSI1 0x71 /* Generic ANSI SCSI-1 tape unit */
  98. #define MT_ISSCSI2 0x72 /* Generic ANSI SCSI-2 tape unit */
  99. /* QIC-40/80/3010/3020 ftape supported drives.
  100.  * 20bit vendor ID + 0x800000 (see ftape-vendors.h)
  101.  */
  102. #define MT_ISFTAPE_UNKNOWN 0x800000 /* obsolete */
  103. #define MT_ISFTAPE_FLAG 0x800000
  104. struct mt_tape_info {
  105. long t_type; /* device type id (mt_type) */
  106. char *t_name; /* descriptive name */
  107. };
  108. #define MT_TAPE_INFO { 
  109. {MT_ISUNKNOWN, "Unknown type of tape device"}, 
  110. {MT_ISQIC02, "Generic QIC-02 tape streamer"}, 
  111. {MT_ISWT5150, "Wangtek 5150, QIC-150"}, 
  112. {MT_ISARCHIVE_5945L2, "Archive 5945L-2"}, 
  113. {MT_ISCMSJ500, "CMS Jumbo 500"}, 
  114. {MT_ISTDC3610, "Tandberg TDC 3610, QIC-24"}, 
  115. {MT_ISARCHIVE_VP60I, "Archive VP60i, QIC-02"}, 
  116. {MT_ISARCHIVE_2150L, "Archive Viper 2150L"}, 
  117. {MT_ISARCHIVE_2060L, "Archive Viper 2060L"}, 
  118. {MT_ISARCHIVESC499, "Archive SC-499 QIC-36 controller"}, 
  119. {MT_ISQIC02_ALL_FEATURES, "Generic QIC-02 tape, all features"}, 
  120. {MT_ISWT5099EEN24, "Wangtek 5099-een24, 60MB"}, 
  121. {MT_ISTEAC_MT2ST, "Teac MT-2ST 155mb data cassette drive"}, 
  122. {MT_ISEVEREX_FT40A, "Everex FT40A, QIC-40"}, 
  123. {MT_ISONSTREAM_SC,      "OnStream SC-, DI-, DP-, or USB tape drive"}, 
  124. {MT_ISSCSI1, "Generic SCSI-1 tape"}, 
  125. {MT_ISSCSI2, "Generic SCSI-2 tape"}, 
  126. {0, NULL} 
  127. }
  128. /* structure for MTIOCPOS - mag tape get position command */
  129. struct mtpos {
  130. long  mt_blkno; /* current block number */
  131. };
  132. /* structure for MTIOCGETCONFIG/MTIOCSETCONFIG primarily intended
  133.  * as an interim solution for QIC-02 until DDI is fully implemented.
  134.  */
  135. struct mtconfiginfo {
  136. long mt_type; /* drive type */
  137. long ifc_type; /* interface card type */
  138. unsigned short irqnr; /* IRQ number to use */
  139. unsigned short dmanr; /* DMA channel to use */
  140. unsigned short port; /* IO port base address */
  141. unsigned long debug; /* debugging flags */
  142. unsigned have_dens:1;
  143. unsigned have_bsf:1;
  144. unsigned have_fsr:1;
  145. unsigned have_bsr:1;
  146. unsigned have_eod:1;
  147. unsigned have_seek:1;
  148. unsigned have_tell:1;
  149. unsigned have_ras1:1;
  150. unsigned have_ras2:1;
  151. unsigned have_ras3:1;
  152. unsigned have_qfa:1;
  153. unsigned pad1:5;
  154. char reserved[10];
  155. };
  156. /*  structure for MTIOCVOLINFO, query information about the volume
  157.  *  currently positioned at (zftape)
  158.  */
  159. struct mtvolinfo {
  160. unsigned int mt_volno;   /* vol-number */
  161. unsigned int mt_blksz;   /* blocksize used when recording */
  162. unsigned int mt_rawsize; /* raw tape space consumed, in kb */
  163. unsigned int mt_size;    /* volume size after decompression, in kb */
  164. unsigned int mt_cmpr:1;  /* this volume has been compressed */
  165. };
  166. /* raw access to a floppy drive, read and write an arbitrary segment.
  167.  * For ftape/zftape to support formatting etc.
  168.  */
  169. #define MT_FT_RD_SINGLE  0
  170. #define MT_FT_RD_AHEAD   1
  171. #define MT_FT_WR_ASYNC   0 /* start tape only when all buffers are full     */
  172. #define MT_FT_WR_MULTI   1 /* start tape, continue until buffers are empty  */
  173. #define MT_FT_WR_SINGLE  2 /* write a single segment and stop afterwards    */
  174. #define MT_FT_WR_DELETE  3 /* write deleted data marks, one segment at time */
  175. struct mtftseg
  176. {            
  177. unsigned mt_segno;   /* the segment to read or write */
  178. unsigned mt_mode;    /* modes for read/write (sync/async etc.) */
  179. int      mt_result;  /* result of r/w request, not of the ioctl */
  180. void    *mt_data;    /* User space buffer: must be 29kb */
  181. };
  182. /* get tape capacity (ftape/zftape)
  183.  */
  184. struct mttapesize {
  185. unsigned long mt_capacity; /* entire, uncompressed capacity 
  186.     * of a cartridge
  187.     */
  188. unsigned long mt_used;     /* what has been used so far, raw 
  189.     * uncompressed amount
  190.     */
  191. };
  192. /*  possible values of the ftfmt_op field
  193.  */
  194. #define FTFMT_SET_PARMS 1 /* set software parms */
  195. #define FTFMT_GET_PARMS 2 /* get software parms */
  196. #define FTFMT_FORMAT_TRACK 3 /* start formatting a tape track   */
  197. #define FTFMT_STATUS 4 /* monitor formatting a tape track */
  198. #define FTFMT_VERIFY 5 /* verify the given segment        */
  199. struct ftfmtparms {
  200. unsigned char  ft_qicstd;   /* QIC-40/QIC-80/QIC-3010/QIC-3020 */
  201. unsigned char  ft_fmtcode;  /* Refer to the QIC specs */
  202. unsigned char  ft_fhm;      /* floppy head max */
  203. unsigned char  ft_ftm;      /* floppy track max */
  204. unsigned short ft_spt;      /* segments per track */
  205. unsigned short ft_tpc;      /* tracks per cartridge */
  206. };
  207. struct ftfmttrack {
  208. unsigned int  ft_track;   /* track to format */
  209. unsigned char ft_gap3;    /* size of gap3, for FORMAT_TRK */
  210. };
  211. struct ftfmtstatus {
  212. unsigned int  ft_segment;  /* segment currently being formatted */
  213. };
  214. struct ftfmtverify {
  215. unsigned int  ft_segment;   /* segment to verify */
  216. unsigned long ft_bsm;       /* bsm as result of VERIFY cmd */
  217. };
  218. struct mtftformat {
  219. unsigned int fmt_op;      /* operation to perform */
  220. union fmt_arg {
  221. struct ftfmtparms  fmt_parms;  /* format parameters */
  222. struct ftfmttrack  fmt_track;  /* ctrl while formatting */
  223. struct ftfmtstatus fmt_status;
  224. struct ftfmtverify fmt_verify; /* for verifying */ 
  225. } fmt_arg;
  226. };
  227. struct mtftcmd {
  228. unsigned int ft_wait_before; /* timeout to wait for drive to get ready 
  229.       * before command is sent. Milliseconds
  230.       */
  231. qic117_cmd_t ft_cmd;         /* command to send */
  232. unsigned char ft_parm_cnt;   /* zero: no parm is sent. */
  233. unsigned char ft_parms[3];   /* parameter(s) to send to
  234.       * the drive. The parms are nibbles
  235.       * driver sends cmd + 2 step pulses */
  236. unsigned int ft_result_bits; /* if non zero, number of bits
  237.       * returned by the tape drive
  238.       */
  239. unsigned int ft_result;      /* the result returned by the tape drive*/
  240. unsigned int ft_wait_after;  /* timeout to wait for drive to get ready
  241.       * after command is sent. 0: don't wait */
  242. int ft_status;              /* status returned by ready wait
  243.       * undefined if timeout was 0.
  244.       */
  245. int ft_error;                /* error code if error status was set by 
  246.       * command
  247.       */
  248. };
  249. /* mag tape io control commands */
  250. #define MTIOCTOP _IOW('m', 1, struct mtop) /* do a mag tape op */
  251. #define MTIOCGET _IOR('m', 2, struct mtget) /* get tape status */
  252. #define MTIOCPOS _IOR('m', 3, struct mtpos) /* get tape position */
  253. /* The next two are used by the QIC-02 driver for runtime reconfiguration.
  254.  * See tpqic02.h for struct mtconfiginfo.
  255.  */
  256. #define MTIOCGETCONFIG _IOR('m', 4, struct mtconfiginfo) /* get tape config */
  257. #define MTIOCSETCONFIG _IOW('m', 5, struct mtconfiginfo) /* set tape config */
  258. /* the next six are used by the floppy ftape drivers and its frontends
  259.  * sorry, but MTIOCTOP commands are write only.
  260.  */
  261. #define MTIOCRDFTSEG    _IOWR('m', 6, struct mtftseg)  /* read a segment */
  262. #define MTIOCWRFTSEG    _IOWR('m', 7, struct mtftseg)   /* write a segment */
  263. #define MTIOCVOLINFO _IOR('m',  8, struct mtvolinfo) /* info about volume */
  264. #define MTIOCGETSIZE    _IOR('m',  9, struct mttapesize)/* get cartridge size*/
  265. #define MTIOCFTFORMAT   _IOWR('m', 10, struct mtftformat) /* format ftape */
  266. #define MTIOCFTCMD _IOWR('m', 11, struct mtftcmd) /* send QIC-117 cmd */
  267. /* Generic Mag Tape (device independent) status macros for examining
  268.  * mt_gstat -- HP-UX compatible.
  269.  * There is room for more generic status bits here, but I don't
  270.  * know which of them are reserved. At least three or so should
  271.  * be added to make this really useful.
  272.  */
  273. #define GMT_EOF(x)              ((x) & 0x80000000)
  274. #define GMT_BOT(x)              ((x) & 0x40000000)
  275. #define GMT_EOT(x)              ((x) & 0x20000000)
  276. #define GMT_SM(x)               ((x) & 0x10000000)  /* DDS setmark */
  277. #define GMT_EOD(x)              ((x) & 0x08000000)  /* DDS EOD */
  278. #define GMT_WR_PROT(x)          ((x) & 0x04000000)
  279. /* #define GMT_ ?  ((x) & 0x02000000) */
  280. #define GMT_ONLINE(x)           ((x) & 0x01000000)
  281. #define GMT_D_6250(x)           ((x) & 0x00800000)
  282. #define GMT_D_1600(x)           ((x) & 0x00400000)
  283. #define GMT_D_800(x)            ((x) & 0x00200000)
  284. /* #define GMT_ ?  ((x) & 0x00100000) */
  285. /* #define GMT_ ?  ((x) & 0x00080000) */
  286. #define GMT_DR_OPEN(x)          ((x) & 0x00040000)  /* door open (no tape) */
  287. /* #define GMT_ ?  ((x) & 0x00020000) */
  288. #define GMT_IM_REP_EN(x)        ((x) & 0x00010000)  /* immediate report mode */
  289. #define GMT_CLN(x)              ((x) & 0x00008000)  /* cleaning requested */
  290. /* 15 generic status bits unused */
  291. /* SCSI-tape specific definitions */
  292. /* Bitfield shifts in the status  */
  293. #define MT_ST_BLKSIZE_SHIFT 0
  294. #define MT_ST_BLKSIZE_MASK 0xffffff
  295. #define MT_ST_DENSITY_SHIFT 24
  296. #define MT_ST_DENSITY_MASK 0xff000000
  297. #define MT_ST_SOFTERR_SHIFT 0
  298. #define MT_ST_SOFTERR_MASK 0xffff
  299. /* Bitfields for the MTSETDRVBUFFER ioctl */
  300. #define MT_ST_OPTIONS 0xf0000000
  301. #define MT_ST_BOOLEANS 0x10000000
  302. #define MT_ST_SETBOOLEANS 0x30000000
  303. #define MT_ST_CLEARBOOLEANS 0x40000000
  304. #define MT_ST_WRITE_THRESHOLD 0x20000000
  305. #define MT_ST_DEF_BLKSIZE 0x50000000
  306. #define MT_ST_DEF_OPTIONS 0x60000000
  307. #define MT_ST_TIMEOUTS 0x70000000
  308. #define MT_ST_SET_TIMEOUT (MT_ST_TIMEOUTS | 0x000000)
  309. #define MT_ST_SET_LONG_TIMEOUT (MT_ST_TIMEOUTS | 0x100000)
  310. #define MT_ST_SET_CLN 0x80000000
  311. #define MT_ST_BUFFER_WRITES 0x1
  312. #define MT_ST_ASYNC_WRITES 0x2
  313. #define MT_ST_READ_AHEAD 0x4
  314. #define MT_ST_DEBUGGING 0x8
  315. #define MT_ST_TWO_FM 0x10
  316. #define MT_ST_FAST_MTEOM 0x20
  317. #define MT_ST_AUTO_LOCK 0x40
  318. #define MT_ST_DEF_WRITES 0x80
  319. #define MT_ST_CAN_BSR 0x100
  320. #define MT_ST_NO_BLKLIMS 0x200
  321. #define MT_ST_CAN_PARTITIONS    0x400
  322. #define MT_ST_SCSI2LOGICAL      0x800
  323. #define MT_ST_SYSV              0x1000
  324. #define MT_ST_NOWAIT            0x2000
  325. /* The mode parameters to be controlled. Parameter chosen with bits 20-28 */
  326. #define MT_ST_CLEAR_DEFAULT 0xfffff
  327. #define MT_ST_DEF_DENSITY (MT_ST_DEF_OPTIONS | 0x100000)
  328. #define MT_ST_DEF_COMPRESSION (MT_ST_DEF_OPTIONS | 0x200000)
  329. #define MT_ST_DEF_DRVBUFFER (MT_ST_DEF_OPTIONS | 0x300000)
  330. /* The offset for the arguments for the special HP changer load command. */
  331. #define MT_ST_HPLOADER_OFFSET 10000
  332. #endif /* _LINUX_MTIO_H */