xref: /freebsd/share/man/man4/xpt.4 (revision 193d9e768ba63fcfb187cfd17f461f7d41345048)
1.\"
2.\" Copyright (c) 1998 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$
29.\"
30.Dd October 10, 1998
31.Dt XPT 4
32.Os
33.Sh NAME
34.Nm xpt
35.Nd CAM transport layer interface
36.Sh SYNOPSIS
37None.
38.Sh DESCRIPTION
39The
40.Nm
41driver provides a way for userland applications to issue certain CAM CCBs
42to the kernel.
43.Pp
44Since the
45.Nm
46driver allows direct access to the CAM subsystem, system administrators
47should exercise caution when granting access to this driver.
48If used
49improperly, this driver can allow userland applications to crash a machine
50or cause data loss.
51.Sh KERNEL CONFIGURATION
52There is no kernel configuration required for the
53.Nm
54driver.
55It is enabled when
56.Tn SCSI
57support is enabled in the kernel.
58There is one instance of the xpt driver
59per CAM transport layer instance.
60Since there is currently only one CAM
61transport layer, there will only be one instance of this driver.
62.Sh IOCTLS
63.Bl -tag -width 01234567890123
64.It CAMIOCOMMAND
65This ioctl takes certain kinds of CAM CCBs and passes them through to the
66CAM transport layer for action.
67Only the following CCB types are
68supported:
69.Pp
70.Bl -tag -width XPT_DEV_MATCH -compact
71.It XPT_SCAN_BUS
72.It XPT_RESET_BUS
73.It XPT_SCAN_LUN
74.It XPT_ENG_INQ
75.It XPT_ENG_EXEC
76.It XPT_DEBUG
77.It XPT_DEV_MATCH
78.It XPT_PATH_INQ
79.El
80.Pp
81The above CCBs are the only ones supported since it makes more sense to
82send them through a generic passthrough device rather than a passthrough
83device tied to a particular underlying
84.Tn SCSI
85device.
86.It CAMGETPASSTHRU
87This ioctl takes an XPT_GDEVLIST CCB, and returns the passthrough device
88corresponding to the device in question.
89.El
90.Sh FILES
91.Bl -tag -width /dev/xpt0 -compact
92.It Pa /dev/xpt0
93Character device node for the
94.Nm
95driver.
96.El
97.Sh DIAGNOSTICS
98None.
99.Sh SEE ALSO
100.Xr cam 3 ,
101.Xr cam_cdbparse 3 ,
102.Xr pass 4 ,
103.Xr camcontrol 8
104.Sh HISTORY
105The CAM transport layer driver first appeared in
106.Fx 3.0 .
107.Sh AUTHORS
108.An Kenneth Merry Aq Mt ken@FreeBSD.org
109