share/man/man4/sa.4

   1 .\" Copyright (c) 1996
   2 .\"     Julian Elischer <julian@FreeBSD.org>.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\"
  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 .\"
  14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24 .\" SUCH DAMAGE.
  25 .\"
  26 .\" $FreeBSD$
  27 .\"
  28 .Dd June 6, 1999
  29 .Dt SA 4
  30 .Os
  31 .Sh NAME
  32 .Nm sa
  33 .Nd SCSI Sequential Access device driver
  34 .Sh SYNOPSIS
  35 .Cd device sa
  36 .Sh DESCRIPTION
  37 The
  38 .Nm
  39 driver provides support for all
  40 .Tn SCSI
  41 devices of the sequential access class that are attached to the system
  42 through a supported
  43 .Tn SCSI
  44 Host Adapter.
  45 The sequential access class includes tape and other linear access devices.
  46 .Pp
  47 A
  48 .Tn SCSI
  49 Host
  50 adapter must also be separately configured into the system
  51 before a
  52 .Tn SCSI
  53 sequential access device can be configured.
  54 .Sh MOUNT SESSIONS
  55 The
  56 .Nm
  57 driver is based around the concept of a
  58 .Dq Em mount session ,
  59 which is defined as the period between the time that a tape is
  60 mounted, and the time when it is unmounted.
  61 Any parameters set during
  62 a mount session remain in effect for the remainder of the session or
  63 until replaced.
  64 The tape can be unmounted, bringing the session to a
  65 close in several ways.
  66 These include:
  67 .Bl -enum
  68 .It
  69 Closing a `rewind device',
  70 referred to as sub-mode 00 below.
  71 An example is
  72 .Pa /dev/sa0 .
  73 .It
  74 Using the MTOFFL
  75 .Xr ioctl 2
  76 command, reachable through the
  77 .Sq Cm offline
  78 command of
  79 .Xr mt 1 .
  80 .El
  81 .Pp
  82 It should be noted that tape devices are exclusive open devices, except in
  83 the case where a control mode device is opened.
  84 In the latter case, exclusive
  85 access is only sought when needed (e.g., to set parameters).
  86 .Sh SUB-MODES
  87 Bits 0 and 1 of the minor number are interpreted as
  88 .Sq sub-modes .
  89 The sub-modes differ in the action taken when the device is closed:
  90 .Bl -tag -width XXXX
  91 .It 00
  92 A close will rewind the device; if the tape has been
  93 written, then a file mark will be written before the rewind is requested.
  94 The device is unmounted.
  95 .It 01
  96 A close will leave the tape mounted.
  97 If the tape was written to, a file mark will be written.
  98 No other head positioning takes place.
  99 Any further reads or writes will occur directly after the
 100 last read, or the written file mark.
 101 .It 10
 102 A close will rewind the device.
 103 If the tape has been
 104 written, then a file mark will be written before the rewind is requested.
 105 On completion of the rewind an unload command will be issued.
 106 The device is unmounted.
 107 .El
 108 .Sh BLOCKING MODES
 109 .Tn SCSI
 110 tapes may run in either
 111 .Sq Em variable
 112 or
 113 .Sq Em fixed
 114 block-size modes.
 115 Most
 116 .Tn QIC Ns -type
 117 devices run in fixed block-size mode, where most nine-track tapes and
 118 many new cartridge formats allow variable block-size.
 119 The difference between the two is as follows:
 120 .Bl -inset
 121 .It Variable block-size:
 122 Each write made to the device results in a single logical record
 123 written to the tape.
 124 One can never read or write
 125 .Em part
 126 of a record from tape (though you may request a larger block and read
 127 a smaller record); nor can one read multiple blocks.
 128 Data from a single write is therefore read by a single read.
 129 The block size used
 130 may be any value supported by the device, the
 131 .Tn SCSI
 132 adapter and the system (usually between 1 byte and 64 Kbytes,
 133 sometimes more).
 134 .Pp
 135 When reading a variable record/block from the tape, the head is
 136 logically considered to be immediately after the last item read,
 137 and before the next item after that.
 138 If the next item is a file mark,
 139 but it was never read, then the next
 140 process to read will immediately hit the file mark and receive an end-of-file notification.
 141 .It Fixed block-size:
 142 Data written by the user is passed to the tape as a succession of
 143 fixed size blocks.
 144 It may be contiguous in memory, but it is
 145 considered to be a series of independent blocks.
 146 One may never write
 147 an amount of data that is not an exact multiple of the blocksize.
 148 One may read and write the same data as a different set of records.
 149 In other words, blocks that were written together may be read separately,
 150 and vice-versa.
 151 .Pp
 152 If one requests more blocks than remain in the file, the drive will
 153 encounter the file mark.
 154 As there is some data to return (unless
 155 there were no records before the file mark), the read will succeed,
 156 returning that data.
 157 The next read will return immediately with a value
 158 of 0.
 159 (As above, if the file mark is never read, it remains for the next
 160 process to read if in no-rewind mode.)
 161 .El
 162 .Sh FILE MARK HANDLING
 163 The handling of file marks on write is automatic.
 164 If the user has
 165 written to the tape, and has not done a read since the last write,
 166 then a file mark will be written to the tape when the device is
 167 closed.
 168 If a rewind is requested after a write, then the driver
 169 assumes that the last file on the tape has been written, and ensures
 170 that there are two file marks written to the tape.
 171 The exception to
 172 this is that there seems to be a standard (which we follow, but do not
 173 understand why) that certain types of tape do not actually write two
 174 file marks to tape, but when read, report a `phantom' file mark when the
 175 last file is read.
 176 These devices include the QIC family of devices.
 177 (It might be that this set of devices is the same set as that of fixed
 178 block devices.
 179 This has not been determined yet, and they are treated
 180 as separate behaviors by the driver at this time.)
 181 .Sh IOCTLS
 182 The
 183 .Nm
 184 driver supports all of the ioctls of
 185 .Xr mtio 4 .
 186 .Sh FILES
 187 .Bl -tag -width /dev/[n][e]sa[0-9] -compact
 188 .It Pa /dev/[n][e]sa[0-9]
 189 general form:
 190 .It Pa /dev/sa0
 191 Rewind on close
 192 .It Pa /dev/nsa0
 193 No rewind on close
 194 .It Pa /dev/esa0
 195 Eject on close (if capable)
 196 .It Pa /dev/sa0.ctl
 197 Control mode device (to examine state while another program is
 198 accessing the device, e.g.).
 199 .El
 200 .Sh DIAGNOSTICS
 201 None.
 202 .Sh SEE ALSO
 203 .Xr cam 4 ,
 204 .Xr mt 1
 205 .Sh AUTHORS
 206 .An -nosplit
 207 The
 208 .Nm
 209 driver was written for the
 210 .Tn CAM
 211 .Tn SCSI
 212 subsystem by
 213 .An Justin T. Gibbs
 214 and
 215 .An Kenneth Merry .
 216 Many ideas were gleaned from the
 217 .Nm st
 218 device driver written and ported from
 219 .Tn Mach
 220 2.5
 221 by
 222 .An Julian Elischer .
 223 .Pp
 224 The current owner of record is
 225 .An Matthew Jacob
 226 who has suffered too many
 227 years of breaking tape drivers.
 228 .Sh BUGS
 229 This driver lacks many of the hacks required to deal with older devices.
 230 Many older
 231 .Tn SCSI-1
 232 devices may not work properly with this driver yet.
 233 .Pp
 234 Additionally, certain
 235 tapes (QIC tapes mostly) that were written under
 236 .Fx
 237 2.X
 238 are not automatically read correctly with this driver: you may need to
 239 explicitly set variable block mode or set to the blocksize that works best
 240 for your device in order to read tapes written under
 241 .Fx
 242 2.X.
 243 .Pp
 244 Fine grained density and compression mode support that is bound to specific
 245 device names needs to be added.
 246 .Pp
 247 Support for fast indexing by use of partitions is missing.