From 28b8f26147935653d6830d326fdce45844f4458c Mon Sep 17 00:00:00 2001 From: ken Date: Mon, 12 Oct 1998 00:26:03 +0000 Subject: Add man pages for the passthrough driver and the CAM transport layer driver. --- share/man/man4/Makefile | 4 +- share/man/man4/pass.4 | 110 ++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 112 insertions(+), 2 deletions(-) create mode 100644 share/man/man4/pass.4 (limited to 'share') diff --git a/share/man/man4/Makefile b/share/man/man4/Makefile index 891c7ad..980e518 100644 --- a/share/man/man4/Makefile +++ b/share/man/man4/Makefile @@ -3,10 +3,10 @@ MAN4= bpf.4 ccd.4 cd.4 ch.4 ddb.4 divert.4 drum.4 fd.4 fpa.4 \ icmp.4 ifmib.4 inet.4 intro.4 ip.4 ipfirewall.4 \ lkm.4 lo.4 natm.4 netintro.4 \ - null.4 od.4 ppi.4 ppp.4 pt.4 pty.4 route.4 \ + null.4 od.4 pass.4 ppi.4 ppp.4 pt.4 pty.4 route.4 \ scsi.4 sd.4 sl.4 smp.4 snp.4 sppp.4 ssc.4 st.4 su.4 tcp.4 \ ttcp.4 termios.4 tty.4 tun.4 udp.4 uk.4 update.4 unix.4 vinum.4 vn.4 \ - worm.4 yp.4 zero.4 + worm.4 xpt.4 yp.4 zero.4 MLINKS+=fd.4 stderr.4 fd.4 stdin.4 fd.4 stdout.4 MLINKS+=netintro.4 networking.4 diff --git a/share/man/man4/pass.4 b/share/man/man4/pass.4 new file mode 100644 index 0000000..01413f5 --- /dev/null +++ b/share/man/man4/pass.4 @@ -0,0 +1,110 @@ +.\" +.\" Copyright (c) 1998 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. +.\" +.\" $Id$ +.\" +.Dd October 10, 1998 +.Dt PASS 4 +.Os FreeBSD 3.0 +.Sh NAME +.Nm pass +.Nd CAM application passthrough driver +.Sh SYNOPSIS +.Cd device pass0 +.Cd device pass2 at scbus0 target 3 lun 0 +.Sh DESCRIPTION +The +.Nm pass +driver provides a way for userland applications to issue CAM CCBs to the +kernel. +.Pp +Since the +.Nm pass +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 pass +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 pass +device in the kernel; +.Nm pass +devices are automatically allocated as +.Tn SCSI +devices are found. +.Sh IOCTLS +.Bl -tag -width 012345678901234 +.It CAMIOCOMMAND +This ioctl takes any kind of CAM CCB and passes it through to the CAM +transport layer for action. +.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 pass +driver, it is of limited use, since the caller must already know that +the device in question is a passthrough device if they're issuing this +ioctl. It is probably more useful to issue this ioctl through the +.Xr xpt 4 +device. +.El +.Sh FILES +.Bl -tag -width 01234567890 -compact +.It Pa /dev/pass Ns Ar n +Character device nodes for the +.Nm pass +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 xpt 4 , +.Xr camcontrol 8 , +.Xr cam 9 , +.Xr ccb 9 , +.Xr xpt 9 , +.Sh HISTORY +The CAM passthrough driver first appeared in +.Fx 3.0 . +.Sh AUTHORS +.An Kenneth Merry Aq 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. -- cgit v1.1