Additional/modified man pages. From Steve Rumble.

This commit is contained in:
sekiya 2004-02-08 13:25:39 +00:00
parent 4eccb08bd5
commit 9c7e102c58
8 changed files with 287 additions and 17 deletions

View File

@ -1,6 +1,7 @@
# $NetBSD: Makefile,v 1.4 2003/12/15 06:28:01 lonewolf Exp $
# $NetBSD: Makefile,v 1.5 2004/02/08 13:25:39 sekiya Exp $
MAN= crime.4 gio.4 haltwo.4 hpc.4 imc.4 intro.4 mace.4 newport.4
MAN= crime.4 dpclock.4 dsclock.4 gio.4 haltwo.4 hpc.4 imc.4 intro.4 \
mace.4 newport.4 pic.4 wdsc.4
MANSUBDIR=/sgimips
.include <bsd.man.mk>

View File

@ -0,0 +1,58 @@
.\" $NetBSD: dpclock.4,v 1.1 2004/02/08 13:25:39 sekiya Exp $
.\"
.\" Copyright (c) 2004 The NetBSD Foundation, Inc.
.\" All rights reserved.
.\"
.\" This document is derived from work contributed to The NetBSD Foundation
.\" by Steve Rumble.
.\"
.\" 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. All advertising materials mentioning features or use of this software
.\" must display the following acknowledgement:
.\" This product includes software developed by the NetBSD
.\" Foundation, Inc. and its contributors.
.\" 4. Neither the name of The NetBSD Foundation nor the names of its
.\" contributors may be used to endorse or promote products derived
.\" from this software without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. 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 FOUNDATION 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.
.\"
.Dd January 24, 2004
.Dt DPCLOCK 4 sgimips
.Os
.Sh NAME
.Nm dpclock
.Nd DP8573A real-time clock
.Sh SYNOPSIS
.Cd "dpclock* at hpc0 offset ?"
.Sh DESCRIPTION
The
.Nm
driver provides support for the DP8573A real-time clock (RTC). This
device appears on SGI Personal Iris 4D/2x, 4D/3x and Indigo R3k machines.
Note that the kernel expects the RTC to run in UTC.
.Sh SEE ALSO
.Xr dsclock 4 ,
.Xr intro 4
.Sh HISTORY
The
.Nm
driver first appeared in
.Nx 2.0 .

View File

@ -0,0 +1,58 @@
.\" $NetBSD: dsclock.4,v 1.1 2004/02/08 13:25:39 sekiya Exp $
.\"
.\" Copyright (c) 2004 The NetBSD Foundation, Inc.
.\" All rights reserved.
.\"
.\" This document is derived from work contributed to The NetBSD Foundation
.\" by Steve Rumble.
.\"
.\" 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. All advertising materials mentioning features or use of this software
.\" must display the following acknowledgement:
.\" This product includes software developed by the NetBSD
.\" Foundation, Inc. and its contributors.
.\" 4. Neither the name of The NetBSD Foundation nor the names of its
.\" contributors may be used to endorse or promote products derived
.\" from this software without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. 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 FOUNDATION 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.
.\"
.Dd January 24, 2004
.Dt DSCLOCK 4 sgimips
.Os
.Sh NAME
.Nm dsclock
.Nd DS1286 real-time clock
.Sh SYNOPSIS
.Cd "dsclock* at hpc0 offset ?"
.Sh DESCRIPTION
The
.Nm
driver provides support for the DS1286 real-time clock (RTC). This device
appears on SGI Indy and Indigo2 machines. Note that the kernel expects the
RTC to run in UTC.
.Sh SEE ALSO
.Xr dpclock 4 ,
.Xr intro 4
.Sh HISTORY
The
.Nm
driver first appeared in
.Nx 1.6 .

View File

@ -1,4 +1,4 @@
.\" $NetBSD: gio.4,v 1.3 2002/05/20 16:19:50 pooka Exp $
.\" $NetBSD: gio.4,v 1.4 2004/02/08 13:25:39 sekiya Exp $
.\"
.\" Copyright (c) 2002 The NetBSD Foundation, Inc.
.\" All rights reserved.
@ -34,7 +34,7 @@
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
.\" POSSIBILITY OF SUCH DAMAGE.
.\"
.Dd May 19, 2002
.Dd January 24, 2004
.Dt GIO 4 sgimips
.Os
.Sh NAME
@ -42,6 +42,7 @@
.Nd SGI's early PCI-like bus
.Sh SYNOPSIS
.Cd "gio0 at imc0"
.Cd "gio0 at pic0"
.Sh DESCRIPTION
The
.Nm gio
@ -50,12 +51,15 @@ CPU. The devices themselves are connected to the
.Xr hpc 4
peripheral controller, and memory and CPU are accessed through the
.Xr imc 4
(Indy Memory Controller). The
(Indy Memory Controller) or
.Xr pic 4
(Processor Interface Controller). The
.Nm
bus is found for example on the Indy and Indigo2 machines.
bus is found on the Indigo, Indy and Indigo2 machines.
.Sh SEE ALSO
.Xr hpc 4 ,
.Xr imc 4
.Xr imc 4 ,
.Xr pic 4
.Sh HISTORY
The
.Nm

View File

@ -1,4 +1,4 @@
.\" $NetBSD: hpc.4,v 1.3 2003/12/15 06:28:01 lonewolf Exp $
.\" $NetBSD: hpc.4,v 1.4 2004/02/08 13:25:39 sekiya Exp $
.\"
.\" Copyright (c) 2002 The NetBSD Foundation, Inc.
.\" All rights reserved.
@ -34,7 +34,7 @@
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
.\" POSSIBILITY OF SUCH DAMAGE.
.\"
.Dd December 15, 2003
.Dd January 24, 2004
.Dt HPC 4 sgimips
.Os
.Sh NAME
@ -48,11 +48,13 @@ interfaces the peripherals connected to it to the
.Xr gio 4
bus.
.Nm
is found for example on the Indy and Indigo2 machines.
is found on the Personal Iris 4D/3x, Indigo, Indy and Indigo2 machines.
.Sh HARDWARE
.Bl -tag -width dsclock -offset indent
.It dsclock
DS1286-based RTC
.It dpclock
DP8573A-based RTC
.It haltwo
HAL2 audio controller
.It sq
@ -68,7 +70,8 @@ Zilog Z8530 UART
.El
.Sh SEE ALSO
.Xr gio 4 ,
.Xr imc 4
.Xr imc 4 ,
.Xr pic 4
.Sh HISTORY
The
.Nm

View File

@ -1,4 +1,4 @@
.\" $NetBSD: intro.4,v 1.3 2003/05/06 07:44:55 wiz Exp $
.\" $NetBSD: intro.4,v 1.4 2004/02/08 13:25:39 sekiya Exp $
.\"
.\" Copyright (c) 2003 The NetBSD Foundation, Inc.
.\" All rights reserved.
@ -31,7 +31,7 @@
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
.\" POSSIBILITY OF SUCH DAMAGE.
.\"
.Dd April 29, 2003
.Dd January 24, 2004
.Dt INTRO 4 sgimips
.Os
.Sh NAME
@ -90,13 +90,22 @@ A list of the supported devices is given below.
.Sh HARDWARE
The following systems are supported:
.Pp
.Bl -tag -width XXXXXX -offset indent -compact
.Bl -tag -width XXXXXXXXXX -offset indent -compact
.It O2
IP32
.Pq Dq Moosehead
.It Indy
IP24
.Pq Dq Guiness
.Pq Dq Guinness
.It Indigo 2
IP22
.Pq Dq Fullhouse
.It Indigo R4k
IP20
.Pq Dq Blackjack
.It Indigo R3k
IP12
.Pq Dq Hollywood
.El
.Sh LIST OF DEVICES
The devices listed below are supported in this incarnation of the
@ -109,19 +118,27 @@ Not all supported devices are listed.
found on the O2
.It dsclock
real-time clock
.It dpclock
real-time clock
.It gio
.It hpc
High performance Peripheral Controller
.It imc
found on the Indy/Indigo2
Indigo R4k/Indy/Indigo2 bus arbitrator
.It mace
found on the O2
.It macepci
.It mec
O2 MAC110 ethernet
.It newport
entry framebuffer on Indy and Indigo2
.It pic
Personal Iris 4D/3x and Indigo R3k bus arbitrator
.It sbic
WD33C93 SCSI interface
.It sq
ethernet
SEEQ 8003/80C03 ethernet
.It wdsc
WD33C93 SCSI interface
.El
@ -145,6 +162,7 @@ bus and associated device drivers.
.Xr hpc 4 ,
.Xr imc 4 ,
.Xr mace 4 ,
.Xr pic 4 ,
.Xr config 8
.Sh HISTORY
This

View File

@ -0,0 +1,57 @@
.\" $NetBSD: pic.4,v 1.1 2004/02/08 13:25:39 sekiya Exp $
.\"
.\" Copyright (c) 2004 The NetBSD Foundation, Inc.
.\" All rights reserved.
.\"
.\" This document is derived from work contributed to The NetBSD Foundation
.\" by Steve Rumble.
.\"
.\" 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. All advertising materials mentioning features or use of this software
.\" must display the following acknowledgement:
.\" This product includes software developed by the NetBSD
.\" Foundation, Inc. and its contributors.
.\" 4. Neither the name of The NetBSD Foundation nor the names of its
.\" contributors may be used to endorse or promote products derived
.\" from this software without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. 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 FOUNDATION 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.
.\"
.Dd January 24, 2004
.Dt PIC 4 sgimips
.Os
.Sh NAME
.Nm pic
.Nd Processor Interface Controller
.Sh SYNOPSIS
.Cd "pic0 at mainbus0 addr 0x1fa00000"
.Sh DESCRIPTION
The Processor Interface Controller interfaces the
.Xr gio 4
or VME bus to main memory and CPU. The
.Nm
is found in the Personal Iris 4D/3x and Indigo R3k machines.
.Sh SEE ALSO
.Xr gio 4
.Sh HISTORY
The
.Nm
driver first appeared in
.Nx 2.0 .

View File

@ -0,0 +1,71 @@
.\" $NetBSD: wdsc.4,v 1.1 2004/02/08 13:25:39 sekiya Exp $
.\"
.\" Copyright (c) 1999 The NetBSD Foundation, Inc.
.\" All rights reserved.
.\"
.\" This code is derived from software contributed to The NetBSD Foundation
.\" by Steve C. Woodford.
.\"
.\" 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. All advertising materials mentioning features or use of this software
.\" must display the following acknowledgement:
.\" This product includes software developed by the NetBSD
.\" Foundation, Inc. and its contributors.
.\" 4. Neither the name of The NetBSD Foundation nor the names of its
.\" contributors may be used to endorse or promote products derived
.\" from this software without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. 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 FOUNDATION 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.
.\"
.Dd January 24, 2004
.Os
.Dt WDSC 4 sgimips
.Sh NAME
.Nm wdsc
.Nd Western Digital WD33c93 SCSI Bus Interface Controller
.Sh SYNOPSIS
.Cd "wdsc* at hpc? offset ?"
.Sh DESCRIPTION
The
.Nm
driver provides an abstraction layer between the SCSI hardware
found in multitudinous SGI machines (including Personal Iris series,
Indigo, Indy, and Indigo2) and the machine independent SCSI drivers
described in
.Xr scsibus 4 .
.Pp
In addition to sending the required SCSI commands to
target devices on the SCSI bus, the
.Nm
driver deals with DMA, device interrupts, sync/async negotiation
and target disconnects/reconnects.
.Sh SEE ALSO
.Xr hpc 4 ,
.Xr scsibus 4
.Sh BUGS
The current
.Nm
driver should be blown away and replaced with a machine independent
version as variants also exist in the amiga, atari, and mvme68k ports.
.Sh HISTORY
Wayne Knowles ported the sgimips incarnation of the
.Nm
driver from the amiga and atari ports. It first appeared in
.Nx 1.6 .