diff options
author | Martin Reindl <martin@cvs.openbsd.org> | 2007-03-01 22:53:45 +0000 |
---|---|---|
committer | Martin Reindl <martin@cvs.openbsd.org> | 2007-03-01 22:53:45 +0000 |
commit | ad5278f00c762e04be531340533778f5210a0385 (patch) | |
tree | da7520ea0e0a52c0fc0debfec4eef45979ad73fa /share/man/man4/man4.landisk | |
parent | dd62e9c1742b49f6a10001419d1539547eb05707 (diff) |
shrink the list of missing landisk section 4 manpages, more to come
Diffstat (limited to 'share/man/man4/man4.landisk')
-rw-r--r-- | share/man/man4/man4.landisk/Makefile | 6 | ||||
-rw-r--r-- | share/man/man4/man4.landisk/intro.4 | 142 | ||||
-rw-r--r-- | share/man/man4/man4.landisk/mainbus.4 | 62 | ||||
-rw-r--r-- | share/man/man4/man4.landisk/obio.4 | 4 | ||||
-rw-r--r-- | share/man/man4/man4.landisk/power.4 | 8 | ||||
-rw-r--r-- | share/man/man4/man4.landisk/shpcic.4 | 38 |
6 files changed, 251 insertions, 9 deletions
diff --git a/share/man/man4/man4.landisk/Makefile b/share/man/man4/man4.landisk/Makefile index 21c8be6213f..7f766cb7358 100644 --- a/share/man/man4/man4.landisk/Makefile +++ b/share/man/man4/man4.landisk/Makefile @@ -1,7 +1,7 @@ -# $OpenBSD: Makefile,v 1.2 2007/01/29 19:17:20 martin Exp $ +# $OpenBSD: Makefile,v 1.3 2007/03/01 22:53:44 martin Exp $ -# TODO: autoconf intro mainbus scif shb rsclock shpcic -MAN= obio.4 power.4 mem.4 +# TODO: autoconf scif shb rsclock +MAN= intro.4 obio.4 power.4 shpcic.4 mainbus.4 mem.4 MANSUBDIR=landisk #MLINKS+= mem.4 kmem.4 diff --git a/share/man/man4/man4.landisk/intro.4 b/share/man/man4/man4.landisk/intro.4 new file mode 100644 index 00000000000..b14fbfd9e2f --- /dev/null +++ b/share/man/man4/man4.landisk/intro.4 @@ -0,0 +1,142 @@ +.\" $OpenBSD: intro.4,v 1.1 2007/03/01 22:53:44 martin 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 March 2, 2007 +.Dt INTRO 4 landisk +.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 landisk 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 lotsofletters -compact -offset indent +.It Xr cd 4 +ATAPI or SCSI CD drives. +.It Xr obio 4 +Onboard I/O bus device. +.It Xr pciide 4 +PCI IDE controller. +.It Xr power 4 +Power switch. +.\" cpu +.It Xr sd 4 +SCSI disks. +.\" rsclock +.\" shb +.\" scif +.It Xr shpcic 4 +SuperH PCI-Host Bridge. +.It Xr wd 4 +IDE disks. +.It Xr wdc 4 +IDE disk controller. +.El +.Pp +A further list of available devices is contained within the pages +describing the system buses and controllers. +For example, a PCI device would be listed in the +.Xr pci 4 +man page. +The following buses and controllers list these devices: +.Pp +.Bl -tag -width "cardbus(4)XX" -offset 3n -compact +.It Xr pci 4 +introduction to PCI bus support +.It Xr usb 4 +introduction to Universal Serial Bus support +.El +.Sh SEE ALSO +.Xr autoconf 4 , +.Xr config 8 +.Sh HISTORY +The +landisk +.Nm intro +first appeared in +.Ox 4.1 . diff --git a/share/man/man4/man4.landisk/mainbus.4 b/share/man/man4/man4.landisk/mainbus.4 new file mode 100644 index 00000000000..82269acdfcb --- /dev/null +++ b/share/man/man4/man4.landisk/mainbus.4 @@ -0,0 +1,62 @@ +.\" +.\" Copyright (c) 1997 Colin Wood +.\" 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 Colin Wood +.\" for the NetBSD Project. +.\" 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. +.\" +.\" $OpenBSD: mainbus.4,v 1.1 2007/03/01 22:53:44 martin Exp $ +.\" $NetBSD: mainbus.4,v 1.1 1997/07/18 02:13:40 ender Exp $ +.\" +.Dd March 2, 2007 +.Dt MAINBUS 4 landisk +.Os +.Sh NAME +.Nm mainbus +.Nd landisk main processor bus device +.Sh SYNOPSIS +.Cd "mainbus0 at root" +.Cd "cpu0 at mainbus?" +.Cd "shb* at mainbus?" +.Cd "shpcic* at mainbus?" +.Cd "obio0 at mainbus?" +.Sh DESCRIPTION +The +.Nm +interface serves as an abstraction used by the autoconfiguration +system to help find and attach buses or devices connected to the +.Tn landisk +main processor bus. +.Sh SEE ALSO +.Xr intro 4 , +.Xr obio 4 , +.\" shb +.Xr shpcic 4 +.Sh HISTORY +The +.Nm +first appeared in +.Ox 4.1 . diff --git a/share/man/man4/man4.landisk/obio.4 b/share/man/man4/man4.landisk/obio.4 index 4e338c67569..4e1651f0351 100644 --- a/share/man/man4/man4.landisk/obio.4 +++ b/share/man/man4/man4.landisk/obio.4 @@ -28,7 +28,7 @@ .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .\" -.\" $OpenBSD: obio.4,v 1.2 2007/01/30 06:04:14 jmc Exp $ +.\" $OpenBSD: obio.4,v 1.3 2007/03/01 22:53:44 martin Exp $ .\" $NetBSD: obio.4,v 1.1 1997/07/18 02:13:40 ender Exp $ .\" .Dd January 16, 2007 @@ -59,7 +59,7 @@ power switch WD100x compatible hard disk controller driver .El .\".Sh SEE ALSO -.\".Xr intro 4 , +.Xr intro 4 , .\".Xr mainbus 4 .Sh HISTORY The diff --git a/share/man/man4/man4.landisk/power.4 b/share/man/man4/man4.landisk/power.4 index 5e61c0858e1..164cd932438 100644 --- a/share/man/man4/man4.landisk/power.4 +++ b/share/man/man4/man4.landisk/power.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: power.4,v 1.1 2007/01/15 22:37:47 martin Exp $ +.\" $OpenBSD: power.4,v 1.2 2007/03/01 22:53:44 martin Exp $ .\" .\" .\" Copyright (c) 2007 Martin Reindl @@ -37,9 +37,9 @@ is set to 1, will signal .Xr init 8 to do a clean shutdown. -./".Sh SEE ALSO -./".Xr obio 4 , -./".Xr intro 4 , +.Sh SEE ALSO +.Xr obio 4 , +.Xr intro 4 , .Sh HISTORY Support for the .Nm diff --git a/share/man/man4/man4.landisk/shpcic.4 b/share/man/man4/man4.landisk/shpcic.4 new file mode 100644 index 00000000000..001a02e8a0d --- /dev/null +++ b/share/man/man4/man4.landisk/shpcic.4 @@ -0,0 +1,38 @@ +.\" $OpenBSD: shpcic.4,v 1.1 2007/03/01 22:53:44 martin Exp $ +.\" +.\" Copyright (c) 2004 Martin Reindl +.\" +.\" Permission to use, copy, modify, and distribute this software for any +.\" purpose with or without fee is hereby granted, provided that the above +.\" copyright notice and this permission notice appear in all copies. +.\" +.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES +.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF +.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR +.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN +.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF +.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. +.\" +.Dd March 2, 2007 +.Dt SHPCIC 4 landisk +.Os +.Sh NAME +.Nm shpcic +.Nd landisk SuperH PCI-Host Bridge +.Sh SYNOPSIS +.Cd "shpcic* at mainbus?" +.Cd "pci0 at shpcic?" +.Sh DESCRIPTION +The +.Nm +driver provides support for the landisk on-board PCI bus. +This device is largely transparent and provides no user accessible entry points. +.Sh SEE ALSO +.Xr mainbus 4 , +.Xr pci 4 +.Sh HISTORY +The +.Nm +driver first appeared in +.Ox 4.1 . |