Initial import from FreeBSD RELENG_4:
[dragonfly.git] / 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 .\"
28 .Dd March 2, 1995
29 .Dt PT 4
30 .Os
31 .Sh NAME
32 .Nm pt
33 .Nd SCSI processor type driver
34 .Sh SYNOPSIS
35 .Cd device pt
36 .Cd device pt1 at scbus0 target 3 unit 0
37 .Sh DESCRIPTION
38 The
39 .Nm
40 driver provides support for a
41 .Tn SCSI
42 processor type device.  These are usually scanners and other
43 devices using the
44 .Tn SCSI
45 link as a communication interface with device
46 specific commands embedded in the data stream.
47 .Pp
48 A
49 .Tn SCSI
50 adapter must be separately configured into the system
51 before this driver can be used.
52 .Pp
53 This device supports
54 .Xr read 2
55 and
56 .Xr write 2 ,
57 and the
58 .Xr ioctl 2
59 calls described below.
60 .Sh IOCTLS
61 .Bl -tag -width 012345678901234
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 .Aq Pa sys/ptio.h .
68 .Pp
69 .It 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 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 .