xref: /openbsd/share/man/man4/man4.octeon/intro.4 (revision 4bdff4be)
1.\"     $OpenBSD: intro.4,v 1.2 2022/03/31 17:27:22 naddy Exp $
2.\"
3.\" Copyright (c) 1983, 1986, 1991 Regents of the University of California.
4.\" All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\" 3. Neither the name of the University nor the names of its contributors
15.\"    may be used to endorse or promote products derived from this software
16.\"    without specific prior written permission.
17.\"
18.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
19.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
22.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28.\" SUCH DAMAGE.
29.\"
30.Dd $Mdocdate: March 31 2022 $
31.Dt INTRO 4 octeon
32.Os
33.Sh NAME
34.Nm intro
35.Nd introduction to special files and hardware support
36.Sh DESCRIPTION
37The manual pages in section 4 describe the special files,
38related driver functions, and networking support
39available in the system.
40In this part of the manual, the SYNOPSIS section of
41each configurable device gives a sample specification
42for use in constructing a system description for the
43.Xr config 8
44program.
45The DIAGNOSTICS section lists messages which may appear on the console
46and/or in the system error log
47.Pa /var/log/messages
48due to errors in device operation;
49see
50.Xr syslogd 8
51for more information.
52.Pp
53This section contains both devices
54which may be configured into the system
55and network related information.
56The networking support is introduced in
57.Xr netintro 4 .
58.Sh DEVICE SUPPORT
59This section describes the hardware supported on the
60octeon
61platform.
62Software support for these devices comes in two forms.
63A hardware device may be supported with a character or block
64.Em device driver ,
65or it may be used within the networking subsystem and have a
66.Em network interface driver .
67Block and character devices are accessed through files in the file
68system of a special type; see
69.Xr mknod 8 .
70Network interfaces are indirectly accessed through the interprocess
71communication facilities provided by the system; see
72.Xr socket 2 .
73.Pp
74A hardware device is identified to the system at configuration time
75and the appropriate device or network interface driver is then compiled
76into the system.
77When the resultant system is booted, the autoconfiguration facilities
78in the system probe for the device and, if found, enable the software
79support for it.
80If a device does not respond at autoconfiguration
81time, it is not accessible at any time afterwards.
82To enable a device which did not autoconfigure,
83the system will have to be rebooted.
84.Pp
85The autoconfiguration system is described in
86.Xr autoconf 4 .
87.Sh LIST OF DEVICES
88A complete list of available devices is contained within the pages
89describing the system buses and controllers.
90For example, a PCI device would be listed in the
91.Xr pci 4
92man page.
93The following buses and controllers list these devices:
94.Pp
95.Bl -tag -width "cardbus(4)XX" -offset 3n -compact
96.It Xr onewire 4
971-Wire bus
98.It Xr pci 4
99introduction to PCI bus support
100.It Xr usb 4
101introduction to Universal Serial Bus support
102.El
103.Sh SEE ALSO
104.Xr autoconf 4 ,
105.Xr config 8
106.Sh HISTORY
107The
108octeon
109.Nm intro
110first appeared in
111.Ox 7.0 .
112