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