share/man/man4/pt.4

   1 .\" Copyright (c) 1995
   2 .\"     Peter Dufault,  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/pt.4,v 1.8.2.3 2001/08/17 13:08:39 ru Exp $
  27 .\" $DragonFly: src/share/man/man4/pt.4,v 1.5 2008/05/01 23:36:43 swildner Exp $
  28 .\"
  29 .Dd March 2, 1995
  30 .Dt PT 4
  31 .Os
  32 .Sh NAME
  33 .Nm pt
  34 .Nd SCSI processor type driver
  35 .Sh SYNOPSIS
  36 .Cd device pt
  37 .Cd device pt1 at scbus0 target 3 unit 0
  38 .Sh DESCRIPTION
  39 The
  40 .Nm
  41 driver provides support for a
  42 .Tn SCSI
  43 processor type device.  These are usually scanners and other
  44 devices using the
  45 .Tn SCSI
  46 link as a communication interface with device
  47 specific commands embedded in the data stream.
  48 .Pp
  49 A
  50 .Tn SCSI
  51 adapter must be separately configured into the system
  52 before this driver can be used.
  53 .Pp
  54 This device supports
  55 .Xr read 2
  56 and
  57 .Xr write 2 ,
  58 and the
  59 .Xr ioctl 2
  60 calls described below.
  61 .Sh IOCTLS
  62 The following
  63 .Xr ioctl 2
  64 calls are supported by the
  65 .Nm
  66 driver.  They are defined in the header file
  67 .In sys/ptio.h .
  68 .Bl -tag -width 012345678901234
  69 .It Dv PTIOCGETTIMEOUT
  70 This ioctl allows userland applications to fetch the current
  71 .Nm
  72 driver read and write timeout.  The value returned is in seconds.
  73 .It Dv PTIOCSETTIMEOUT
  74 This ioctl allows userland applications to set the current
  75 .Nm
  76 driver read and write timeouts.  The value should be in seconds.
  77 .El
  78 .Sh FILES
  79 .Bl -tag -width /dev/ptQQQ -compact
  80 .It Pa /dev/pt Ns Ar N
  81 the
  82 .Ar N Ns th processor device.
  83 .El
  84 .Sh SEE ALSO
  85 .Xr scsi 4
  86 .Sh HISTORY
  87 The
  88 .Nm
  89 driver appeared in
  90 .Fx 2.1 .