freebsd-skq/share/man/man4/pass.4

.\"
.\" Copyright (c) 1998, 1999 Kenneth D. Merry.
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. The name of the author may not be used to endorse or promote products
.\"    derived from this software without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $FreeBSD$
.\"
.Dd October 10, 1998
.Dt PASS 4
.Os
.Sh NAME
.Nm pass
.Nd CAM application passthrough driver
.Sh SYNOPSIS
.Cd device pass
.Sh DESCRIPTION
The
.Nm
driver provides a way for userland applications to issue CAM CCBs to the
kernel.
.Pp
Since the
.Nm
driver allows direct access to the CAM subsystem, system administrators
should exercise caution when granting access to this driver.
If used
improperly, this driver can allow userland applications to crash a machine
or cause data loss.
.Pp
The
.Nm
driver attaches to every
.Tn SCSI
device found in the system.
Since it attaches to every device, it provides a generic means of accessing
.Tn SCSI
devices, and allows the user to access devices which have no
"standard" peripheral driver associated with them.
.Sh KERNEL CONFIGURATION
It is only necessary to configure one
.Nm
device in the kernel;
.Nm
devices are automatically allocated as
.Tn SCSI
devices are found.
.Sh IOCTLS
.Bl -tag -width 012345678901234
.It CAMIOCOMMAND
This ioctl takes most kinds of CAM CCBs and passes them through to the CAM
transport layer for action.
Note that some CCB types are not allowed
through the passthrough device, and must be sent through the
.Xr xpt 4
device instead.
Some examples of xpt-only CCBs are XPT_SCAN_BUS,
XPT_DEV_MATCH, XPT_RESET_BUS, XPT_SCAN_LUN, XPT_ENG_INQ, and XPT_ENG_EXEC.
These CCB types have various attributes that make it illogical or
impossible to service them through the passthrough interface.
.It CAMGETPASSTHRU
This ioctl takes an XPT_GDEVLIST CCB, and returns the passthrough device
corresponding to the device in question.
Although this ioctl is available through the
.Nm
driver, it is of limited use, since the caller must already know that
the device in question is a passthrough device if they are issuing this
ioctl.
It is probably more useful to issue this ioctl through the
.Xr xpt 4
device.
.El
.Sh FILES
.Bl -tag -width /dev/passn -compact
.It Pa /dev/pass Ns Ar n
Character device nodes for the
.Nm
driver.
There should be one of these for each device accessed through the
CAM subsystem.
.El
.Sh DIAGNOSTICS
None.
.Sh SEE ALSO
.Xr cam 3 ,
.Xr cam 4 ,
.Xr cam_cdbparse 3 ,
.Xr xpt 4 ,
.Xr camcontrol 8
.Sh HISTORY
The CAM passthrough driver first appeared in
.Fx 3.0 .
.Sh AUTHORS
.An Kenneth Merry Aq Mt ken@FreeBSD.org
.Sh BUGS
It might be nice to have a way to asynchronously send CCBs through the
passthrough driver.
This would probably require some sort of read/write
interface or an asynchronous ioctl interface.
Add man pages for the passthrough driver and the CAM transport layer driver. 1998-10-12 00:26:03 +00:00			`.\"`
Devices are hardwired with "unit 0", not "lun 0" as was in these man pages. Also, update the pass(4) man page to indicate that some CCBs must be sent through the xpt(4) device and cannot be sent through a pass device. PR: 8826 1999-05-08 21:28:18 +00:00			`.\" Copyright (c) 1998, 1999 Kenneth D. Merry.`
Add man pages for the passthrough driver and the CAM transport layer driver. 1998-10-12 00:26:03 +00:00			`.\" All rights reserved.`
			`.\"`
			`.\" Redistribution and use in source and binary forms, with or without`
			`.\" modification, are permitted provided that the following conditions`
			`.\" are met:`
			`.\" 1. Redistributions of source code must retain the above copyright`
			`.\" notice, this list of conditions and the following disclaimer.`
			`.\" 2. Redistributions in binary form must reproduce the above copyright`
			`.\" notice, this list of conditions and the following disclaimer in the`
			`.\" documentation and/or other materials provided with the distribution.`
			`.\" 3. The name of the author may not be used to endorse or promote products`
			`.\" derived from this software without specific prior written permission.`
			`.\"`
			.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
			`.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE`
			`.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE`
			`.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE`
			`.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL`
			`.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS`
			`.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)`
			`.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT`
			`.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY`
			`.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF`
			`.\" SUCH DAMAGE.`
			`.\"`
$Id$ -> $FreeBSD$ 1999-08-28 00:22:10 +00:00			`.\" $FreeBSD$`
Add man pages for the passthrough driver and the CAM transport layer driver. 1998-10-12 00:26:03 +00:00			`.\"`
			`.Dd October 10, 1998`
			`.Dt PASS 4`
mdoc(7) police: removed HISTORY info from the .Os call. 2001-07-10 15:31:11 +00:00			`.Os`
Add man pages for the passthrough driver and the CAM transport layer driver. 1998-10-12 00:26:03 +00:00			`.Sh NAME`
			`.Nm pass`
			`.Nd CAM application passthrough driver`
			`.Sh SYNOPSIS`
First round of config related changes to the manpages. device blah0 -> device blah for PCI devices and busses. 2000-01-23 15:04:20 +00:00			`.Cd device pass`
Add man pages for the passthrough driver and the CAM transport layer driver. 1998-10-12 00:26:03 +00:00			`.Sh DESCRIPTION`
			`The`
mdoc(7) police: use the new features of the Nm macro. 2000-11-20 18:41:33 +00:00			`.Nm`
Add man pages for the passthrough driver and the CAM transport layer driver. 1998-10-12 00:26:03 +00:00			`driver provides a way for userland applications to issue CAM CCBs to the`
Removed whitespace at end-of-line; no content changes. I simply did cd src/share; find man[1-9] -type f\|xargs perl -pi -e 's/[ \t]+$//' BTW, what editors are the culprits? I'm using vim and it shows me whitespace at EOL in troff files with a thick blue block... Reviewed by: Silence from cvs diff -b MFC after: 7 days 2001-07-14 19:41:16 +00:00			`kernel.`
Add man pages for the passthrough driver and the CAM transport layer driver. 1998-10-12 00:26:03 +00:00			`.Pp`
			`Since the`
mdoc(7) police: use the new features of the Nm macro. 2000-11-20 18:41:33 +00:00			`.Nm`
Add man pages for the passthrough driver and the CAM transport layer driver. 1998-10-12 00:26:03 +00:00			`driver allows direct access to the CAM subsystem, system administrators`
Hiten's patchset for section four manpages, slightly edited by me. 2003-06-28 23:53:39 +00:00			`should exercise caution when granting access to this driver.`
			`If used`
Add man pages for the passthrough driver and the CAM transport layer driver. 1998-10-12 00:26:03 +00:00			`improperly, this driver can allow userland applications to crash a machine`
			`or cause data loss.`
			`.Pp`
			`The`
mdoc(7) police: use the new features of the Nm macro. 2000-11-20 18:41:33 +00:00			`.Nm`
Add man pages for the passthrough driver and the CAM transport layer driver. 1998-10-12 00:26:03 +00:00			`driver attaches to every`
			`.Tn SCSI`
			`device found in the system.`
			`Since it attaches to every device, it provides a generic means of accessing`
			`.Tn SCSI`
			`devices, and allows the user to access devices which have no`
			`"standard" peripheral driver associated with them.`
			`.Sh KERNEL CONFIGURATION`
			`It is only necessary to configure one`
mdoc(7) police: use the new features of the Nm macro. 2000-11-20 18:41:33 +00:00			`.Nm`
Add man pages for the passthrough driver and the CAM transport layer driver. 1998-10-12 00:26:03 +00:00			`device in the kernel;`
mdoc(7) police: use the new features of the Nm macro. 2000-11-20 18:41:33 +00:00			`.Nm`
Add man pages for the passthrough driver and the CAM transport layer driver. 1998-10-12 00:26:03 +00:00			`devices are automatically allocated as`
			`.Tn SCSI`
			`devices are found.`
			`.Sh IOCTLS`
			`.Bl -tag -width 012345678901234`
			`.It CAMIOCOMMAND`
Devices are hardwired with "unit 0", not "lun 0" as was in these man pages. Also, update the pass(4) man page to indicate that some CCBs must be sent through the xpt(4) device and cannot be sent through a pass device. PR: 8826 1999-05-08 21:28:18 +00:00			`This ioctl takes most kinds of CAM CCBs and passes them through to the CAM`
Hiten's patchset for section four manpages, slightly edited by me. 2003-06-28 23:53:39 +00:00			`transport layer for action.`
			`Note that some CCB types are not allowed`
Devices are hardwired with "unit 0", not "lun 0" as was in these man pages. Also, update the pass(4) man page to indicate that some CCBs must be sent through the xpt(4) device and cannot be sent through a pass device. PR: 8826 1999-05-08 21:28:18 +00:00			`through the passthrough device, and must be sent through the`
			`.Xr xpt 4`
Hiten's patchset for section four manpages, slightly edited by me. 2003-06-28 23:53:39 +00:00			`device instead.`
			`Some examples of xpt-only CCBs are XPT_SCAN_BUS,`
Devices are hardwired with "unit 0", not "lun 0" as was in these man pages. Also, update the pass(4) man page to indicate that some CCBs must be sent through the xpt(4) device and cannot be sent through a pass device. PR: 8826 1999-05-08 21:28:18 +00:00			`XPT_DEV_MATCH, XPT_RESET_BUS, XPT_SCAN_LUN, XPT_ENG_INQ, and XPT_ENG_EXEC.`
			`These CCB types have various attributes that make it illogical or`
			`impossible to service them through the passthrough interface.`
Add man pages for the passthrough driver and the CAM transport layer driver. 1998-10-12 00:26:03 +00:00			`.It CAMGETPASSTHRU`
			`This ioctl takes an XPT_GDEVLIST CCB, and returns the passthrough device`
Hiten's patchset for section four manpages, slightly edited by me. 2003-06-28 23:53:39 +00:00			`corresponding to the device in question.`
			`Although this ioctl is available through the`
mdoc(7) police: use the new features of the Nm macro. 2000-11-20 18:41:33 +00:00			`.Nm`
Add man pages for the passthrough driver and the CAM transport layer driver. 1998-10-12 00:26:03 +00:00			`driver, it is of limited use, since the caller must already know that`
Expand contractions. 2005-02-15 09:27:00 +00:00			`the device in question is a passthrough device if they are issuing this`
Hiten's patchset for section four manpages, slightly edited by me. 2003-06-28 23:53:39 +00:00			`ioctl.`
			`It is probably more useful to issue this ioctl through the`
Add man pages for the passthrough driver and the CAM transport layer driver. 1998-10-12 00:26:03 +00:00			`.Xr xpt 4`
			`device.`
			`.El`
			`.Sh FILES`
Prepare for mdoc(7)NG. 2000-12-29 09:18:45 +00:00			`.Bl -tag -width /dev/passn -compact`
Add man pages for the passthrough driver and the CAM transport layer driver. 1998-10-12 00:26:03 +00:00			`.It Pa /dev/pass Ns Ar n`
			`Character device nodes for the`
mdoc(7) police: use the new features of the Nm macro. 2000-11-20 18:41:33 +00:00			`.Nm`
Hiten's patchset for section four manpages, slightly edited by me. 2003-06-28 23:53:39 +00:00			`driver.`
			`There should be one of these for each device accessed through the`
Add man pages for the passthrough driver and the CAM transport layer driver. 1998-10-12 00:26:03 +00:00			`CAM subsystem.`
			`.El`
			`.Sh DIAGNOSTICS`
			`None.`
			`.Sh SEE ALSO`
			`.Xr cam 3 ,`
Add links to cam(4). 2010-03-04 11:09:49 +00:00			`.Xr cam 4 ,`
Change the worm(4) man page to note that there is no longer a worm(4) driver, and point users in the right direction for similar functionality. The functionality that used to be provided there is now provided by the cd(4) driver and cdrecord. Fix cross-references in a few other man pages. (i.e. delete references to things I haven't written yet) 1998-10-16 00:26:28 +00:00			`.Xr cam_cdbparse 3 ,`
Add man pages for the passthrough driver and the CAM transport layer driver. 1998-10-12 00:26:03 +00:00			`.Xr xpt 4 ,`
Change the worm(4) man page to note that there is no longer a worm(4) driver, and point users in the right direction for similar functionality. The functionality that used to be provided there is now provided by the cd(4) driver and cdrecord. Fix cross-references in a few other man pages. (i.e. delete references to things I haven't written yet) 1998-10-16 00:26:28 +00:00			`.Xr camcontrol 8`
Add man pages for the passthrough driver and the CAM transport layer driver. 1998-10-12 00:26:03 +00:00			`.Sh HISTORY`
			`The CAM passthrough driver first appeared in`
			`.Fx 3.0 .`
			`.Sh AUTHORS`
use .Mt to mark up email addresses consistently (final part) PR: 191174 Submitted by: Franco Fichtner <franco at lastsummer.de> 2014-06-26 21:46:14 +00:00			`.An Kenneth Merry Aq Mt ken@FreeBSD.org`
Add man pages for the passthrough driver and the CAM transport layer driver. 1998-10-12 00:26:03 +00:00			`.Sh BUGS`
			`It might be nice to have a way to asynchronously send CCBs through the`
Hiten's patchset for section four manpages, slightly edited by me. 2003-06-28 23:53:39 +00:00			`passthrough driver.`
			`This would probably require some sort of read/write`
Add man pages for the passthrough driver and the CAM transport layer driver. 1998-10-12 00:26:03 +00:00			`interface or an asynchronous ioctl interface.`