xref: /dragonfly/share/man/man4/pass.4 (revision 335b9e93)
1.\"
2.\" Copyright (c) 1998, 1999 Kenneth D. Merry.
3.\" All rights reserved.
4.\"
5.\" Redistribution and use in source and binary forms, with or without
6.\" modification, are permitted provided that the following conditions
7.\" are met:
8.\" 1. Redistributions of source code must retain the above copyright
9.\"    notice, this list of conditions and the following disclaimer.
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.\" 3. The name of the author may not be used to endorse or promote products
14.\"    derived from this software without specific prior written permission.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26.\" SUCH DAMAGE.
27.\"
28.\" $FreeBSD: src/share/man/man4/pass.4,v 1.5.2.5 2001/08/17 13:08:39 ru Exp $
29.\"
30.Dd October 10, 1998
31.Dt PASS 4
32.Os
33.Sh NAME
34.Nm pass
35.Nd CAM application passthrough driver
36.Sh SYNOPSIS
37.Cd device pass
38.Cd device pass2 at scbus0 target 3 unit 0
39.Sh DESCRIPTION
40The
41.Nm
42driver provides a way for userland applications to issue CAM CCBs to the
43kernel.
44.Pp
45Since the
46.Nm
47driver allows direct access to the CAM subsystem, system administrators
48should exercise caution when granting access to this driver.  If used
49improperly, this driver can allow userland applications to crash a machine
50or cause data loss.
51.Pp
52The
53.Nm
54driver attaches to every
55.Tn SCSI
56device found in the system.
57Since it attaches to every device, it provides a generic means of accessing
58.Tn SCSI
59devices, and allows the user to access devices which have no
60"standard" peripheral driver associated with them.
61.Sh KERNEL CONFIGURATION
62It is only necessary to configure one
63.Nm
64device in the kernel;
65.Nm
66devices are automatically allocated as
67.Tn SCSI
68devices are found.
69.Sh IOCTLS
70.Bl -tag -width ".Dv CAMGETPASSTHRU"
71.It Dv CAMIOCOMMAND
72This ioctl takes most kinds of CAM CCBs and passes them through to the CAM
73transport layer for action.  Note that some CCB types are not allowed
74through the passthrough device, and must be sent through the
75.Xr xpt 4
76device instead.  Some examples of xpt-only CCBs are
77.Dv XPT_SCAN_BUS ,
78.Dv XPT_DEV_MATCH ,
79.Dv XPT_RESET_BUS ,
80.Dv XPT_SCAN_LUN ,
81.Dv XPT_ENG_INQ ,
82and
83.Dv XPT_ENG_EXEC .
84These CCB types have various attributes that make it illogical or
85impossible to service them through the passthrough interface.
86.It Dv CAMGETPASSTHRU
87This ioctl takes an
88.Dv XPT_GDEVLIST
89CCB, and returns the passthrough device
90corresponding to the device in question.  Although this ioctl is available
91through the
92.Nm
93driver, it is of limited use, since the caller must already know that
94the device in question is a passthrough device if they're issuing this
95ioctl.  It is probably more useful to issue this ioctl through the
96.Xr xpt 4
97device.
98.El
99.Sh FILES
100.Bl -tag -width /dev/passn -compact
101.It Pa /dev/pass Ns Ar n
102Character device nodes for the
103.Nm
104driver.  There should be one of these for each device accessed through the
105CAM subsystem.
106.El
107.Sh DIAGNOSTICS
108None.
109.Sh SEE ALSO
110.Xr cam 3 ,
111.Xr cam_cdbparse 3 ,
112.Xr xpt 4 ,
113.Xr camcontrol 8
114.Sh HISTORY
115The CAM passthrough driver first appeared in
116.Fx 3.0 .
117.Sh AUTHORS
118.An Kenneth Merry Aq Mt ken@FreeBSD.org
119.Sh BUGS
120It might be nice to have a way to asynchronously send CCBs through the
121passthrough driver.  This would probably require some sort of read/write
122interface or an asynchronous ioctl interface.
123