From: jsg Date: Fri, 6 Aug 2021 06:35:13 +0000 (+0000) Subject: add riscv64 and octeon intro(4) X-Git-Url: http://artulab.com/gitweb/?a=commitdiff_plain;h=367c3d449c482f46f0dc9115b6511ddfdddf9431;p=openbsd add riscv64 and octeon intro(4) --- diff --git a/share/man/man4/man4.octeon/Makefile b/share/man/man4/man4.octeon/Makefile index e55ef16265b..fc0391116d7 100644 --- a/share/man/man4/man4.octeon/Makefile +++ b/share/man/man4/man4.octeon/Makefile @@ -1,6 +1,6 @@ -# $OpenBSD: Makefile,v 1.23 2020/10/10 09:00:15 visa Exp $ +# $OpenBSD: Makefile,v 1.24 2021/08/06 06:35:13 jsg Exp $ -MAN= amdcf.4 cnmac.4 octboot.4 octcf.4 octcib.4 octcit.4 octciu.4 \ +MAN= amdcf.4 cnmac.4 intro.4 octboot.4 octcf.4 octcib.4 octcit.4 octciu.4 \ octcrypto.4 octgmx.4 octgpio.4 octiic.4 octmmc.4 octpcie.4 octpip.4 \ octrng.4 octrtc.4 octsctl.4 octsmi.4 octuctl.4 octxctl.4 \ ogx.4 ogxnexus.4 diff --git a/share/man/man4/man4.octeon/intro.4 b/share/man/man4/man4.octeon/intro.4 new file mode 100644 index 00000000000..05ae9d7edad --- /dev/null +++ b/share/man/man4/man4.octeon/intro.4 @@ -0,0 +1,111 @@ +.\" $OpenBSD: intro.4,v 1.1 2021/08/06 06:35:13 jsg Exp $ +.\" +.\" Copyright (c) 1983, 1986, 1991 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. +.\" +.Dd $Mdocdate: August 6 2021 $ +.Dt INTRO 4 octeon +.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 SYNOPSIS section of +each configurable device gives a sample specification +for use in constructing a system description for the +.Xr config 8 +program. +The 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 +octeon +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 . +.Sh LIST OF DEVICES +A complete 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 onewire 4 +1-Wire bus +.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 +octeon +.Nm intro +first appeared in +.Ox 7.0 . diff --git a/share/man/man4/man4.riscv64/Makefile b/share/man/man4/man4.riscv64/Makefile index 6f7731b49a9..c31e52f415b 100644 --- a/share/man/man4/man4.riscv64/Makefile +++ b/share/man/man4/man4.riscv64/Makefile @@ -1,6 +1,6 @@ -# $OpenBSD: Makefile,v 1.2 2021/06/18 04:29:09 jsg Exp $ +# $OpenBSD: Makefile,v 1.3 2021/08/06 06:35:13 jsg Exp $ -MAN= plic.4 sfcc.4 sfclock.4 sfuart.4 +MAN= intro.4 plic.4 sfcc.4 sfclock.4 sfuart.4 MANSUBDIR=riscv64 diff --git a/share/man/man4/man4.riscv64/intro.4 b/share/man/man4/man4.riscv64/intro.4 new file mode 100644 index 00000000000..4c13983768b --- /dev/null +++ b/share/man/man4/man4.riscv64/intro.4 @@ -0,0 +1,111 @@ +.\" $OpenBSD: intro.4,v 1.1 2021/08/06 06:35:13 jsg Exp $ +.\" +.\" Copyright (c) 1983, 1986, 1991 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. +.\" +.Dd $Mdocdate: August 6 2021 $ +.Dt INTRO 4 riscv64 +.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 SYNOPSIS section of +each configurable device gives a sample specification +for use in constructing a system description for the +.Xr config 8 +program. +The 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 +riscv64 +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 . +.Sh LIST OF DEVICES +A complete 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 iic 4 +Inter IC (I2C) bus +.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 +riscv64 +.Nm intro +first appeared in +.Ox 7.0 .