Add new drivers' manuals.

This commit is contained in:
minoura 1999-03-17 12:27:22 +00:00
parent af9df0ab31
commit e01101f528
5 changed files with 218 additions and 7 deletions

View File

@ -1,6 +1,6 @@
# $NetBSD: Makefile,v 1.4 1997/10/19 21:22:08 oki Exp $
# $NetBSD: Makefile,v 1.5 1999/03/17 12:27:22 minoura Exp $
MAN= intro.4 pow.4
MAN= intio.4 intro.4 mfp.4 neptune.4 pow.4
MANSUBDIR=/x68k
.include <bsd.man.mk>

View File

@ -0,0 +1,68 @@
.\" $NetBSD: intio.4,v 1.1 1999/03/17 12:27:22 minoura Exp $
.\"
.\" Copyright (c) 1998 MINOURA Makoto
.\" Copyright (c) 1998 NetBSD Foundation, Inc.
.\" 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. All advertising materials mentioning features or use of this software
.\" must display the following acknowledgement:
.\" This product includes software developed by Minoura Makoto.
.\" 4. 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.
.\"
.Dd Mar. 17, 1999
.Os
.Dt INTIO 4 x68k
.Sh NAME
.Nm intio
.Nd "X68K internal I/O space driver"
.Sh SYNOPSIS
.Cd "intio0 at mainbus0"
.Sh DESCRIPTION
.Nm
is a virtual device corresponding to the x68k internal I/O space.
.Pp
Internal I/O space spans from 0xc00000 to 0xffffff of the x68k
physical address space, and is mapped permanently in the kernel virtual space
at the very early time of the kernel startup procedure.
.Pp
.Nm
driver manages the internal I/O space of x68k.
.Pp
.Bl -bullet -offset indent -tag
.It
Address range management to avoid confliction of address space of
which devices probe by touching hardware port is difficult.
.It
Interrupt vector management.
.It
Bus_space(9) and bus_dma(9) implementation.
.It
Other utility functions.
.El
.Pp
.Nm
is always required to run NetBSD kernel.
.Sh SEE ALSO
.Xr intro 4 ,
.Xr bus_space 9 ,
.Xr bus_dma 9 .

View File

@ -31,11 +31,11 @@
.\" SUCH DAMAGE.
.\"
.\" from: @(#)intro.4 5.2 (Berkeley) 3/27/91
.\" $NetBSD: intro.4,v 1.3 1999/03/16 01:19:25 garbled Exp $
.\" $NetBSD: intro.4,v 1.4 1999/03/17 12:27:22 minoura Exp $
.\"
.Dd Sep 11, 1997
.Dt INTRO 4 x68k
.Os
.Os NetBSD 1.3
.Sh NAME
.Nm intro
.Nd introduction to special files and hardware support
@ -97,18 +97,25 @@ A list of the supported devices is given below.
.Sh SEE ALSO
.Xr intro 4 ,
.Xr autoconf 4 ,
.Xr config 8 .
.Xr config 8 ,
.Xr intio 4 ,
.Xr mfp 4 ,
.Xr neptune 4 .
.Sh LIST OF DEVICES
The devices listed below are supported in this incarnation of
the system.
Devices are indicated by their functional interface.
Not all supported devices are listed.
.Bl -tag -width "okiadpcm" -compact -offset indent
.It Em intio
Internal I/O virtual device
.It Em mfp
MC68901 MFP (Multi-Function Periferal)
.It Em spc
Sharp genuin MB89352 SCSI host adaptor
.It Em mha
MK-HA1 Mankai-Seisakusho Mach-2 SCSI host adaptor
.It Em ed
.It Em neptune
Neptune-X Ethernet interface
.It Em fdc
Built-in floppy disk controller device
@ -132,7 +139,7 @@ Z8530 built-in serial interface
.\"Oki MSM6258V AD-PCM
.It Em kbd
x68k Keyboard device
.It Em mouse
.It Em ms
x68k mouse / trackball
.It Em bell
The keyboard bell emulator

View File

@ -0,0 +1,64 @@
.\" $NetBSD: mfp.4,v 1.1 1999/03/17 12:27:22 minoura Exp $
.\"
.\" Copyright (c) 1998 MINOURA Makoto
.\" Copyright (c) 1998 NetBSD Foundation, Inc.
.\" 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. All advertising materials mentioning features or use of this software
.\" must display the following acknowledgement:
.\" This product includes software developed by Minoura Makoto.
.\" 4. 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.
.\"
.Dd Mar. 17, 1999
.Os
.Dt MFP 4 x68k
.Sh NAME
.Nm mfp
.Nd "X68K Multi-function Periferals"
.Sh SYNOPSIS
.Cd mfp0 at intio0 addr 0xe88000 size 0x2000 intr 64
.Sh DESCRIPTION
.Nm
drives Motorola MC68901 MFP (Multi-function Periferal).
.Nm
driver is always required to run the NetBSD/x68k kernel,
because it is connected to importand devices such as
the display controler, and provides fundamental functionalities
like the system clock tick and interrupt controler.
Since
.Nm
provides many functionarities, most of the jobs as a
device driver is done by its child drivers such as
.Xr kbd 4
and
.Xr clock 4 .
.Nm
driver itself only provides the common way to access its
registers and a few utility functions for other non-child drivers.
.Pp
.Sh BUGS
Machine-dependent part and machine-independent part should be splitted.
.Sh SEE ALSO
.Xr intro 4 ,
.Xr kbd 4 ,
.Xr clock 4 .

View File

@ -0,0 +1,72 @@
.\" $NetBSD: neptune.4,v 1.1 1999/03/17 12:27:22 minoura Exp $
.\"
.\" Copyright (c) 1998 MINOURA Makoto
.\" Copyright (c) 1998 NetBSD Foundation, Inc.
.\" 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. All advertising materials mentioning features or use of this software
.\" must display the following acknowledgement:
.\" This product includes software developed by Minoura Makoto.
.\" 4. 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.
.\"
.Dd Mar. 17, 1999
.Dt NEPTUNE 4
.Os NetBSD
.Sh NAME
.Nm neptune
.Nd Neptune-X ISA bridge driver
.Sh SYNOPSIS
.Cd "neptune0 at intio0 addr 0xece000 irq 239"
.Cd "ne0 at neptune? addr 0x300"
.Sh DESCRIPTION
The Neptune-X is a Ethernet interface card initially designed by
Hirofumi Shimada, which utilizes popular NE2000 or its clone with its
own x68k-proprietary bus to ISA bus bridge.
The
.Nx
.Nm
driver takes charge of the ISA bridge part of the Neptune-X.
It is implemented as a more generic `bus' with its own
.Xr bus_space 9
interface, and is intended to be used with
.Xr ne 4
driver.
.Sh SEE ALSO
.Xr intro 4 ,
.Xr ne 4 ,
.Xr isa 4 ,
.Xr bus_space 9 .
.Sh HISTORY
The
.Nm
device appeared in
.Nx 1.4 .
.Sh BUGS
.Nm
itself is always detected when it is specified in the kernel config file.
This is because the Neptune-X ISA bridge is transparent to software.
The attached device is detected appropriately.