mtio.h 11 KB

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