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

.\"
.\" Copyright (c) 1998 Justin T. Gibbs
.\" 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. 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 ``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 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 June 18, 2006
.Dt DPT 4
.Os
.Sh NAME
.Nm dpt
.Nd DPT RAID Controller SCSI driver
.Sh SYNOPSIS
To compile this driver into the kernel,
place the following lines in your
kernel configuration file:
.Bd -ragged -offset indent
.Cd "device scbus"
.Cd "device dpt"
.Pp
For one or more EISA cards:
.Cd "device eisa"
.Pp
For one or more ISA cards:
.Cd "device isa"
.Pp
For one or more PCI cards:
.Cd "device pci"
.Pp
To allow PCI adapters to use memory mapped I/O if enabled:
.Cd options DPT_ALLOW_MEMIO
.Ed
.Pp
Alternatively, to load the driver as a
module at boot time, place the following line in
.Xr loader.conf 5 :
.Bd -literal -offset indent
dpt_load="YES"
.Ed
.Sh DESCRIPTION
The
.Nm
driver supports DPT RAID SCSI controllers.
.Pp
SmartRAID (PM3???) are "Enterprise" class cards,
and SmartCache (PM2???) cards are in the "Workstation" class.
The Gen 4 Smart Cache IV products were a re-issue of the Gen 3 utilizing
upgraded (and cheaper to produce) silicon.
The PM3334 (Smart RAID III) was not revamped as there was no upgraded silicon
(68040 processor) and it was using the best DPT made.
Note there has been customer confusion over the faster enterprise class card
supported by this driver being an older generation.
The Gen5 cards are supported by the
.Xr asr 4
driver.
.Sh HARDWARE
The
.Nm
driver provides support for the following RAID adapters:
.Pp
.Bl -bullet -compact
.It
DPT Smart Cache Plus
.It
Smart Cache II (PM2?2?, PM2022 [EISA], PM2024/PM2124 [PCI]) (Gen2)
.It
Smart RAID II (PM3?2?, PM3021, PM3222)
.It
Smart Cache III (PM2?3?)
.It
Smart RAID III (PM3?3?, PM3332 [EISA], PM3334UW [PCI]) (Gen3)
.It
Smart Cache IV (PM2?4?, PM2042 [EISA], PM2044/PM2144 [PCI]) (Gen4)
.It
Smart RAID IV
.El
.Sh SEE ALSO
.Xr asr 4 ,
.Xr cd 4 ,
.Xr ch 4 ,
.Xr da 4 ,
.Xr sa 4 ,
.Xr scsi 4
.Sh HISTORY
The
.Nm
driver first appeared in
.Fx 2.2.6 .
.Sh AUTHORS
.An -nosplit
The
.Nm
driver was written by
.An Simon Shapiro
and ported to the CAM SCSI system by
.An Justin T. Gibbs .
Add the dpt(4) man page. Reviewed by: ken Submitted by: gibbs 1998-10-16 22:00:55 +00:00			`.\"`
			`.\" Copyright (c) 1998 Justin T. Gibbs`
			`.\" 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. The name of the author may not be used to endorse or promote products`
			`.\" derived from this software without specific prior written permission`
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			`.\"`
Add the dpt(4) man page. Reviewed by: ken Submitted by: gibbs 1998-10-16 22:00:55 +00:00			.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 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 the dpt(4) man page. Reviewed by: ken Submitted by: gibbs 1998-10-16 22:00:55 +00:00			`.\"`
o Remove FILES section (uninteresting for users) o Xref asr(4) MFC after: 3 days 2006-06-18 14:37:48 +00:00			`.Dd June 18, 2006`
Remove the MD part from the document title. Forgotten by: obrien 2001-02-20 11:07:27 +00:00			`.Dt DPT 4`
mdoc(7) police: removed HISTORY info from the .Os call. 2001-07-10 15:31:11 +00:00			`.Os`
Add the dpt(4) man page. Reviewed by: ken Submitted by: gibbs 1998-10-16 22:00:55 +00:00			`.Sh NAME`
			`.Nm dpt`
			`.Nd DPT RAID Controller SCSI driver`
			`.Sh SYNOPSIS`
o Convert to our new SYNOPSIS layout o Add "device scbus/pci/etc" where needed for consistency MFC after: 3 days 2006-06-18 09:53:00 +00:00			`To compile this driver into the kernel,`
			`place the following lines in your`
			`kernel configuration file:`
			`.Bd -ragged -offset indent`
			`.Cd "device scbus"`
Third round of config related changes to the manpages. device blah0 -> device blah for PCI devices and busses. 2000-01-23 17:00:18 +00:00			`.Cd "device dpt"`
Add the dpt(4) man page. Reviewed by: ken Submitted by: gibbs 1998-10-16 22:00:55 +00:00			`.Pp`
o Convert to our new SYNOPSIS layout o Add "device scbus/pci/etc" where needed for consistency MFC after: 3 days 2006-06-18 09:53:00 +00:00			`For one or more EISA cards:`
			`.Cd "device eisa"`
			`.Pp`
			`For one or more ISA cards:`
			`.Cd "device isa"`
			`.Pp`
			`For one or more PCI cards:`
Third round of config related changes to the manpages. device blah0 -> device blah for PCI devices and busses. 2000-01-23 17:00:18 +00:00			`.Cd "device pci"`
Add the dpt(4) man page. Reviewed by: ken Submitted by: gibbs 1998-10-16 22:00:55 +00:00			`.Pp`
			`To allow PCI adapters to use memory mapped I/O if enabled:`
			`.Cd options DPT_ALLOW_MEMIO`
o Convert to our new SYNOPSIS layout o Add "device scbus/pci/etc" where needed for consistency MFC after: 3 days 2006-06-18 09:53:00 +00:00			`.Ed`
			`.Pp`
			`Alternatively, to load the driver as a`
			`module at boot time, place the following line in`
			`.Xr loader.conf 5 :`
			`.Bd -literal -offset indent`
			`dpt_load="YES"`
			`.Ed`
Add the dpt(4) man page. Reviewed by: ken Submitted by: gibbs 1998-10-16 22:00:55 +00:00			`.Sh DESCRIPTION`
			`The`
			`.Nm`
Add a HARDWARE section which lists supported devices. The actual device listings has been moved (and in some cases more or less rewritten) from the DESCRIPTION section. This will be used later for automatically generating device listings in the Hardware Notes, by parsing the manual pages. Reviewed in principle by: ru, hrs, trhodes No objections: -doc, re Section name inspired by: NetBSD 2004-07-04 14:17:41 +00:00			`driver supports DPT RAID SCSI controllers.`
			`.Pp`
			`SmartRAID (PM3???) are "Enterprise" class cards,`
			`and SmartCache (PM2???) cards are in the "Workstation" class.`
			`The Gen 4 Smart Cache IV products were a re-issue of the Gen 3 utilizing`
			`upgraded (and cheaper to produce) silicon.`
			`The PM3334 (Smart RAID III) was not revamped as there was no upgraded silicon`
			`(68040 processor) and it was using the best DPT made.`
			`Note there has been customer confusion over the faster enterprise class card`
			`supported by this driver being an older generation.`
			`The Gen5 cards are supported by the`
			`.Xr asr 4`
			`driver.`
			`.Sh HARDWARE`
			`The`
			`.Nm`
Embellish the list of supported devices. 2003-03-02 22:56:04 +00:00			`driver provides support for the following RAID adapters:`
Compact the list. 2003-05-20 22:07:30 +00:00			`.Pp`
			`.Bl -bullet -compact`
Embellish the list of supported devices. 2003-03-02 22:56:04 +00:00			`.It`
			`DPT Smart Cache Plus`
			`.It`
			`Smart Cache II (PM2?2?, PM2022 [EISA], PM2024/PM2124 [PCI]) (Gen2)`
			`.It`
			`Smart RAID II (PM3?2?, PM3021, PM3222)`
			`.It`
			`Smart Cache III (PM2?3?)`
			`.It`
			`Smart RAID III (PM3?3?, PM3332 [EISA], PM3334UW [PCI]) (Gen3)`
			`.It`
			`Smart Cache IV (PM2?4?, PM2042 [EISA], PM2044/PM2144 [PCI]) (Gen4)`
Catch up dpt(4) manpage with Hardware Notes (and RELENG_4 manpage?!?). PR: 55530 Submitted by: Lukas Ertl <l.ertl@univie.ac.at> 2003-08-19 04:37:54 +00:00			`.It`
			`Smart RAID IV`
Embellish the list of supported devices. 2003-03-02 22:56:04 +00:00			`.El`
Add the dpt(4) man page. Reviewed by: ken Submitted by: gibbs 1998-10-16 22:00:55 +00:00			`.Sh SEE ALSO`
o Remove FILES section (uninteresting for users) o Xref asr(4) MFC after: 3 days 2006-06-18 14:37:48 +00:00			`.Xr asr 4 ,`
Add the dpt(4) man page. Reviewed by: ken Submitted by: gibbs 1998-10-16 22:00:55 +00:00			`.Xr cd 4 ,`
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			`.Xr ch 4 ,`
Add the dpt(4) man page. Reviewed by: ken Submitted by: gibbs 1998-10-16 22:00:55 +00:00			`.Xr da 4 ,`
Various man page cleanup: - Sort xrefs - FreeBSD.ORG -> FreeBSD.org - Be consistent with section names as outlined in mdoc(7). - Other misc mdoc cleanup. PR: doc/13144 Submitted by: Alexey M. Zelkin <phantom@cris.net> 1999-08-15 10:48:36 +00:00			`.Xr sa 4 ,`
			`.Xr scsi 4`
Sort sections. 2005-01-21 08:36:40 +00:00			`.Sh HISTORY`
			`The`
			`.Nm`
			`driver first appeared in`
			`.Fx 2.2.6 .`
Add the dpt(4) man page. Reviewed by: ken Submitted by: gibbs 1998-10-16 22:00:55 +00:00			`.Sh AUTHORS`
mdoc(7) police: do not split author names in the AUTHORS section. 2000-11-22 09:35:58 +00:00			`.An -nosplit`
Add the dpt(4) man page. Reviewed by: ken Submitted by: gibbs 1998-10-16 22:00:55 +00:00			`The`
			`.Nm`
			`driver was written by`
			`.An Simon Shapiro`
			`and ported to the CAM SCSI system by`
			`.An Justin T. Gibbs .`