xref: /openbsd-src/share/man/man4/man4.octeon/intro.4 (revision 41ce3b17e73f6b7d2d9e1a3d961e4bab2d895cb5)
1*41ce3b17Snaddy.\"     $OpenBSD: intro.4,v 1.2 2022/03/31 17:27:22 naddy Exp $
2367c3d44Sjsg.\"
3367c3d44Sjsg.\" Copyright (c) 1983, 1986, 1991 Regents of the University of California.
4367c3d44Sjsg.\" All rights reserved.
5367c3d44Sjsg.\"
6367c3d44Sjsg.\" Redistribution and use in source and binary forms, with or without
7367c3d44Sjsg.\" modification, are permitted provided that the following conditions
8367c3d44Sjsg.\" are met:
9367c3d44Sjsg.\" 1. Redistributions of source code must retain the above copyright
10367c3d44Sjsg.\"    notice, this list of conditions and the following disclaimer.
11367c3d44Sjsg.\" 2. Redistributions in binary form must reproduce the above copyright
12367c3d44Sjsg.\"    notice, this list of conditions and the following disclaimer in the
13367c3d44Sjsg.\"    documentation and/or other materials provided with the distribution.
14367c3d44Sjsg.\" 3. Neither the name of the University nor the names of its contributors
15367c3d44Sjsg.\"    may be used to endorse or promote products derived from this software
16367c3d44Sjsg.\"    without specific prior written permission.
17367c3d44Sjsg.\"
18367c3d44Sjsg.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
19367c3d44Sjsg.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20367c3d44Sjsg.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21367c3d44Sjsg.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
22367c3d44Sjsg.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23367c3d44Sjsg.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24367c3d44Sjsg.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25367c3d44Sjsg.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26367c3d44Sjsg.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27367c3d44Sjsg.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28367c3d44Sjsg.\" SUCH DAMAGE.
29367c3d44Sjsg.\"
30*41ce3b17Snaddy.Dd $Mdocdate: March 31 2022 $
31367c3d44Sjsg.Dt INTRO 4 octeon
32367c3d44Sjsg.Os
33367c3d44Sjsg.Sh NAME
34367c3d44Sjsg.Nm intro
35367c3d44Sjsg.Nd introduction to special files and hardware support
36367c3d44Sjsg.Sh DESCRIPTION
37367c3d44SjsgThe manual pages in section 4 describe the special files,
38367c3d44Sjsgrelated driver functions, and networking support
39367c3d44Sjsgavailable in the system.
40367c3d44SjsgIn this part of the manual, the SYNOPSIS section of
41367c3d44Sjsgeach configurable device gives a sample specification
42367c3d44Sjsgfor use in constructing a system description for the
43367c3d44Sjsg.Xr config 8
44367c3d44Sjsgprogram.
45367c3d44SjsgThe DIAGNOSTICS section lists messages which may appear on the console
46367c3d44Sjsgand/or in the system error log
47367c3d44Sjsg.Pa /var/log/messages
48367c3d44Sjsgdue to errors in device operation;
49367c3d44Sjsgsee
50367c3d44Sjsg.Xr syslogd 8
51367c3d44Sjsgfor more information.
52367c3d44Sjsg.Pp
53367c3d44SjsgThis section contains both devices
54367c3d44Sjsgwhich may be configured into the system
55367c3d44Sjsgand network related information.
56367c3d44SjsgThe networking support is introduced in
57367c3d44Sjsg.Xr netintro 4 .
58367c3d44Sjsg.Sh DEVICE SUPPORT
59367c3d44SjsgThis section describes the hardware supported on the
60367c3d44Sjsgocteon
61367c3d44Sjsgplatform.
62367c3d44SjsgSoftware support for these devices comes in two forms.
63367c3d44SjsgA hardware device may be supported with a character or block
64367c3d44Sjsg.Em device driver ,
65367c3d44Sjsgor it may be used within the networking subsystem and have a
66367c3d44Sjsg.Em network interface driver .
67367c3d44SjsgBlock and character devices are accessed through files in the file
68367c3d44Sjsgsystem of a special type; see
69367c3d44Sjsg.Xr mknod 8 .
70367c3d44SjsgNetwork interfaces are indirectly accessed through the interprocess
71367c3d44Sjsgcommunication facilities provided by the system; see
72367c3d44Sjsg.Xr socket 2 .
73367c3d44Sjsg.Pp
74367c3d44SjsgA hardware device is identified to the system at configuration time
75367c3d44Sjsgand the appropriate device or network interface driver is then compiled
76367c3d44Sjsginto the system.
77367c3d44SjsgWhen the resultant system is booted, the autoconfiguration facilities
78367c3d44Sjsgin the system probe for the device and, if found, enable the software
79367c3d44Sjsgsupport for it.
80367c3d44SjsgIf a device does not respond at autoconfiguration
81*41ce3b17Snaddytime, it is not accessible at any time afterwards.
82367c3d44SjsgTo enable a device which did not autoconfigure,
83367c3d44Sjsgthe system will have to be rebooted.
84367c3d44Sjsg.Pp
85367c3d44SjsgThe autoconfiguration system is described in
86367c3d44Sjsg.Xr autoconf 4 .
87367c3d44Sjsg.Sh LIST OF DEVICES
88367c3d44SjsgA complete list of available devices is contained within the pages
89367c3d44Sjsgdescribing the system buses and controllers.
90367c3d44SjsgFor example, a PCI device would be listed in the
91367c3d44Sjsg.Xr pci 4
92367c3d44Sjsgman page.
93367c3d44SjsgThe following buses and controllers list these devices:
94367c3d44Sjsg.Pp
95367c3d44Sjsg.Bl -tag -width "cardbus(4)XX" -offset 3n -compact
96367c3d44Sjsg.It Xr onewire 4
97367c3d44Sjsg1-Wire bus
98367c3d44Sjsg.It Xr pci 4
99367c3d44Sjsgintroduction to PCI bus support
100367c3d44Sjsg.It Xr usb 4
101367c3d44Sjsgintroduction to Universal Serial Bus support
102367c3d44Sjsg.El
103367c3d44Sjsg.Sh SEE ALSO
104367c3d44Sjsg.Xr autoconf 4 ,
105367c3d44Sjsg.Xr config 8
106367c3d44Sjsg.Sh HISTORY
107367c3d44SjsgThe
108367c3d44Sjsgocteon
109367c3d44Sjsg.Nm intro
110367c3d44Sjsgfirst appeared in
111367c3d44Sjsg.Ox 7.0 .
112