summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMiod Vallat <miod@cvs.openbsd.org>2004-02-07 21:00:54 +0000
committerMiod Vallat <miod@cvs.openbsd.org>2004-02-07 21:00:54 +0000
commit724aa1cd776e6bb6d9879ef8c3f5c576dd77103c (patch)
treefedff326ee1bebf23bbe9e6b8dcae9a235402387
parent79aa3ca1d517d679a4585be604890b18a1947b69 (diff)
A start at a cats section 4.
-rw-r--r--share/man/man4/Makefile7
-rw-r--r--share/man/man4/man4.cats/Makefile9
-rw-r--r--share/man/man4/man4.cats/autoconf.452
-rw-r--r--share/man/man4/man4.cats/fcom.454
-rw-r--r--share/man/man4/man4.cats/footbridge.450
-rw-r--r--share/man/man4/man4.cats/intro.4186
-rw-r--r--share/man/man4/man4.cats/mem.475
7 files changed, 430 insertions, 3 deletions
diff --git a/share/man/man4/Makefile b/share/man/man4/Makefile
index 2e86c5d1589..d14d6bb8ebb 100644
--- a/share/man/man4/Makefile
+++ b/share/man/man4/Makefile
@@ -1,4 +1,4 @@
-# $OpenBSD: Makefile,v 1.250 2004/01/07 22:05:02 markus Exp $
+# $OpenBSD: Makefile,v 1.251 2004/02/07 21:00:47 miod Exp $
MAN= aac.4 ac97.4 acphy.4 addcom.4 adv.4 aha.4 ahb.4 ahc.4 \
aic.4 amdpm.4 ami.4 amphy.4 an.4 aria.4 ast.4 atalk.4 \
@@ -56,7 +56,8 @@ MLINKS+=tty.4 cua.4
MLINKS+=usb.4 uhub.4
MLINKS+=vnd.4 svnd.4
-SUBDIR= man4.alpha man4.hp300 man4.hppa man4.i386 man4.mac68k man4.macppc \
- man4.mvme68k man4.mvme88k man4.pegasos man4.sparc man4.sparc64 man4.vax
+SUBDIR= man4.alpha man4.cats man4.hp300 man4.hppa man4.i386 \
+ man4.mac68k man4.macppc man4.mvme68k man4.mvme88k \
+ man4.pegasos man4.sparc man4.sparc64 man4.vax
.include <bsd.prog.mk>
diff --git a/share/man/man4/man4.cats/Makefile b/share/man/man4/man4.cats/Makefile
new file mode 100644
index 00000000000..5b6649cb13b
--- /dev/null
+++ b/share/man/man4/man4.cats/Makefile
@@ -0,0 +1,9 @@
+# $OpenBSD: Makefile,v 1.1 2004/02/07 21:00:53 miod Exp $
+
+# TODO: cpu todclock
+MAN= autoconf.4 fcom.4 footbridge.4 intro.4 mem.4
+
+MLINKS+= mem.4 kmem.4
+MANSUBDIR=cats
+
+.include <bsd.prog.mk>
diff --git a/share/man/man4/man4.cats/autoconf.4 b/share/man/man4/man4.cats/autoconf.4
new file mode 100644
index 00000000000..bc1aebf0ca4
--- /dev/null
+++ b/share/man/man4/man4.cats/autoconf.4
@@ -0,0 +1,52 @@
+.\" $OpenBSD: autoconf.4,v 1.1 2004/02/07 21:00:53 miod Exp $
+.\"
+.\" Copyright (c) 1994 Christopher G. Demetriou
+.\" 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 Christopher G. Demetriou.
+.\" 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 ``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 February 7, 2004
+.Dt AUTOCONF 4 cats
+.Os
+.Sh NAME
+.Nm autoconf
+.Nd diagnostics from the autoconfiguration code
+.Sh DESCRIPTION
+When
+.Ox
+bootstraps it probes the innards of the machine
+on which it is running
+and locates controllers, drives, and other devices, printing out
+what it finds on the console.
+This procedure is driven by a system configuration table which is processed by
+.Xr config 8
+and compiled into each kernel.
+Devices which exist in the machine but are not configured into the
+kernel are usually not detected.
+.Sh SEE ALSO
+.Xr intro 4 ,
+.\" .Xr boot_cats 8 ,
+.Xr config 8
diff --git a/share/man/man4/man4.cats/fcom.4 b/share/man/man4/man4.cats/fcom.4
new file mode 100644
index 00000000000..35360621128
--- /dev/null
+++ b/share/man/man4/man4.cats/fcom.4
@@ -0,0 +1,54 @@
+.\" $OpenBSD: fcom.4,v 1.1 2004/02/07 21:00:53 miod Exp $
+.\"
+.\" Copyright (c) 2004, Miodrag Vallat.
+.\"
+.\" 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.
+.\"
+.\" 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 February 7, 2004
+.Dt FCOM 4
+.Os
+.Sh NAME
+.Nm fcom
+.Nd Footbridge serial communications driver
+.Sh SYNOPSIS
+.Cd "fcom0 at footbridge?"
+.Sh DESCRIPTION
+The
+.Nm
+device handles the UART found on the
+.Xr footbridge 4
+device, which provides an RS-232 serial port.
+The
+.Nm
+driver supports all of the standard
+.Xr tty 4
+ioctl calls.
+.Sh SEE ALSO
+.Xr ioctl 2 ,
+.Xr footbridge 4 ,
+.Xr intro 4 ,
+.Xr tty 4
+.Sh HISTORY
+A
+.Nm
+driver appeared in
+.Ox 3.5 .
diff --git a/share/man/man4/man4.cats/footbridge.4 b/share/man/man4/man4.cats/footbridge.4
new file mode 100644
index 00000000000..76548c00ec1
--- /dev/null
+++ b/share/man/man4/man4.cats/footbridge.4
@@ -0,0 +1,50 @@
+.\" $OpenBSD: footbridge.4,v 1.1 2004/02/07 21:00:53 miod Exp $
+.\"
+.\" Copyright (c) 2004, Miodrag Vallat.
+.\"
+.\" 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.
+.\"
+.\" 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 February 7, 2004
+.Dt FOOTBRIDGE 4
+.Os
+.Sh NAME
+.Nm footbridge
+.Nd DC21285 PCI bridge
+.Sh SYNOPSIS
+.Cd "footbridge0 at mainbus?"
+.Cd "fcom0 at footbridge?"
+.Cd "pci0 at footbridge?"
+.Sh DESCRIPTION
+The
+.Nm
+device provides support for the
+.Xr pci 4
+bus on cats systems, and also features an uart and a clock device.
+.Sh SEE ALSO
+.Xr fcom 4 ,
+.Xr intro 4 ,
+.Xr pci 4
+.Sh HISTORY
+A
+.Nm
+driver appeared in
+.Ox 3.5 .
diff --git a/share/man/man4/man4.cats/intro.4 b/share/man/man4/man4.cats/intro.4
new file mode 100644
index 00000000000..62f02c9c787
--- /dev/null
+++ b/share/man/man4/man4.cats/intro.4
@@ -0,0 +1,186 @@
+.\" $OpenBSD: intro.4,v 1.1 2004/02/07 21:00:53 miod Exp $
+.\"
+.\" Copyright (c) 1994 Christopher G. Demetriou
+.\" 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 Christopher G. Demetriou.
+.\" 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 ``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 February 7, 2004
+.Dt INTRO 4 cats
+.Os
+.Sh NAME
+.Nm intro
+.Nd introduction to special files and hardware support
+.Sh DESCRIPTION
+The manual pages in section 4 describe the special files,
+related driver functions, and networking support
+available in the system.
+In this part of the manual, the
+.Tn SYNOPSIS
+section of
+each configurable device gives a sample specification
+for use in constructing a system description for the
+.Xr config 8
+program.
+The
+.Tn DIAGNOSTICS
+section lists messages which may appear on the console
+and/or in the system error log
+.Pa /var/log/messages
+due to errors in device operation;
+see
+.Xr syslogd 8
+for more information.
+.Pp
+This section contains both devices
+which may be configured into the system
+and network related information.
+The networking support is introduced in
+.Xr netintro 4 .
+.Sh DEVICE SUPPORT
+This section describes the hardware supported on the cats platform.
+Software support for these devices comes in two forms.
+A hardware device may be supported with a character or block
+.Em device driver ,
+or it may be used within the networking subsystem and have a
+.Em network interface driver .
+Block and character devices are accessed through files in the file
+system of a special type; see
+.Xr mknod 8 .
+Network interfaces are indirectly accessed through the interprocess
+communication facilities provided by the system; see
+.Xr socket 2 .
+.Pp
+A hardware device is identified to the system at configuration time
+and the appropriate device or network interface driver is then compiled
+into the system.
+When the resultant system is booted, the autoconfiguration facilities
+in the system probe for the device and, if found, enable the software
+support for it.
+If a device does not respond at autoconfiguration
+time it is not accessible at any time afterwards.
+To enable a device which did not autoconfigure,
+the system will have to be rebooted.
+.Pp
+The autoconfiguration system is described in
+.Xr autoconf 4 .
+A list of the supported devices is given below.
+.Sh LIST OF DEVICES
+The devices listed below are supported in this incarnation of
+the system.
+Pseudo-devices are not listed.
+Devices are indicated by their functional interface.
+Not all supported devices are listed.
+.Pp
+.Bl -tag -width pcdisplay(4) -compact -offset indent
+.It Xr adv 4
+AdvanSys PCI narrow SCSI Host Adapters.
+.It Xr ahc 4
+Adaptec 2xxx and 3xxx series PCI/VLB/EISA SCSI adapter boards.
+.It Xr aue 4
+ADMtek AN986-based USB Ethernet adapters.
+.It Xr com 4
+NS8250-, NS16450-, NS16550-, ST16550-, TI16750- and XR16850-based asynchronous
+serial communications.
+.\" cpu
+.It Xr cue 4
+CATC USB-EL1201A based USB Ethernet adapters.
+.It Xr dc 4
+DEC tulip clone ethernet cards (Macronix, Lite-On, Davicom, ADMtek).
+.It Xr de 4
+DEC tulip-based ethernet cards.
+.\" ds1687rtc
+.\" fcom
+.It Xr footbridge 4
+DC21285 PCI bridge.
+.It Xr fxp 4
+.Tn Intel
+EtherExpress PRO/100 Ethernet.
+.It Xr iha 4
+Initio INIC-940 and INIC-950 based SCSI interfaces.
+.It Xr kue 4
+Kawasaki LSI KL5KUSB101B-based USB Ethernet.
+.It Xr lpt 4
+Parallel port.
+.It Xr ne 4
+Novell NE1000 and 2000 Ethernet interface.
+.It Xr pckbc 4
+Traditional PC (ISA) keyboard.
+.It Xr pcscp 4
+Advanced Micro Devices Am53c974 PCscsi-PCI SCSI driver.
+.It Xr pms 4
+PS/2 auxiliary port mouse, for generic mice.
+.\" .It Xr pmsi 4
+.\" PS/2 auxiliary port mouse, for wheel mice.
+.It Xr siop 4
+LSI/Symbios Logic/NCR 53c8xx SCSI adapter boards.
+.\" todclock
+.It Xr uaudio 4
+USB audio devices.
+.It Xr uftdi 4
+FTDI FT8U100AX-based USB serial adapters.
+.It Xr ukbd 4
+USB keyboard.
+.It Xr ulpt 4
+USB printers.
+.It Xr umass 4
+USB mass storage.
+.It Xr umct 4
+MCT USB-RS232 serial adapter.
+.It Xr umidi 4
+USB MIDI devices.
+.It Xr umodem 4
+USB modems.
+.It Xr ums 4
+USB mouse.
+.It Xr upl 4
+Prolific PL2301/PL2302-based host-to-host USB connectors.
+.It Xr uplcom 4
+I/O Data USB-RSAQ2 USB serial adapters.
+.It Xr urio 4
+Diamond Multimedia Rio MP3 device interface.
+.It Xr uscanner 4
+USB scanners.
+.It Xr usscanner 4
+SCSI-over-USB scanners.
+.It Xr uvisor 4
+Handspring Visor device interface.
+.It Xr uyap 4
+YAP phone firmware interface.
+.It Xr vga 4
+PC display adapter driver for VGA compatible adapters.
+.It Xr vr 4
+VIA Rhine Ethernet.
+.El
+.Sh SEE ALSO
+.Xr autoconf 4 ,
+.Xr config 8
+.Sh HISTORY
+The
+cats
+.Nm intro
+first appeared in
+.Ox 3.5 .
diff --git a/share/man/man4/man4.cats/mem.4 b/share/man/man4/man4.cats/mem.4
new file mode 100644
index 00000000000..8770d895f0b
--- /dev/null
+++ b/share/man/man4/man4.cats/mem.4
@@ -0,0 +1,75 @@
+.\" $OpenBSD: mem.4,v 1.1 2004/02/07 21:00:53 miod Exp $
+.\"
+.\" Copyright (c) 1991 The Regents of the University of California.
+.\" 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. Neither the name of the University 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 REGENTS 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 REGENTS 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.
+.\"
+.\" from: @(#)mem.4 5.3 (Berkeley) 5/2/91
+.\"
+.Dd February 7, 2004
+.Dt MEM 4 cats
+.Os
+.Sh NAME
+.Nm mem ,
+.Nm kmem
+.Nd memory files
+.Sh DESCRIPTION
+The special file
+.Pa /dev/mem
+is an interface to the physical memory of the computer.
+Byte offsets in this file are interpreted as physical memory addresses.
+Reading and writing this file is equivalent to reading and writing
+memory itself.
+Only offsets within the bounds of
+.Pa /dev/mem
+are allowed.
+.Pp
+Kernel virtual memory is accessed through the interface
+.Pa /dev/kmem
+in the same manner as
+.Pa /dev/mem .
+Only kernel virtual addresses that are currently mapped to memory are allowed.
+.Pp
+On cats, physical memory is contiguous.
+The kernel virtual memory begins at address
+.Li 0xf0000000.
+.Pp
+Writeability of these devices is controlled by the system
+.Xr securelevel 7 .
+.Sh FILES
+.Bl -tag -width Pa -compact
+.It Pa /dev/mem
+.It Pa /dev/kmem
+.El
+.Sh SEE ALSO
+.Xr securelevel 7
+.Sh HISTORY
+The
+.Pa /dev/mem
+and
+.Pa /dev/kmem
+files appeared in
+.At v6 .