xref: /freebsd/share/man/man4/superio.4 (revision 9f23cbd6cae82fd77edfad7173432fa8dccd0a95)
1.\"
2.\" SPDX-License-Identifier: BSD-2-Clause
3.\"
4.\" Copyright (c) 2019 Andriy Gapon <avg@FreeBSD.org>
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.\"
15.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25.\" SUCH DAMAGE.
26.\"
27.\" $FreeBSD$
28.\"
29.Dd October 11, 2019
30.Dt SUPERIO 4
31.Os
32.Sh NAME
33.Nm superio
34.Nd Super I/O controller and bus driver
35.Sh SYNOPSIS
36To compile this driver into the kernel,
37place the following line in your
38kernel configuration file:
39.Bd -ragged -offset indent
40.Cd "device superio"
41.Ed
42.Pp
43Alternatively, to load the driver as a
44module at boot time, place the following line in
45.Xr loader.conf 5 :
46.Bd -literal -offset indent
47superio_load="YES"
48.Ed
49.Sh DESCRIPTION
50Super I/O is an I/O controller that combines various low-bandwidth devices
51that can be functionally unrelated otherwise.
52A typical Super I/O can contain devices such as
53.Pp
54.Bl -bullet -compact
55.It
56a floppy disk controller
57.It
58a parallel port
59.It
60a serial port
61.It
62a PS/2 mouse and keyboard controller
63.It
64a hardware monitoring controller
65.It
66a watchdog timer
67.It
68a controller for general purpose input-output
69.El
70.Pp
71The
72.Nm
73driver provides support for devices residing in the Super I/O controller
74that can only be accessed or discovered using the controller's interface.
75Some of the Super I/O devices have standardized interfaces.
76Such devices either use well-known legacy resources or they are advertised
77via ACPI or both.
78They can be configured either using ISA bus hints or they are auto-configured by
79.Xr acpi 4 .
80The
81.Nm
82driver is not designed to interact with that kind of devices.
83They can be handled by their respective drivers without any knowledge of the
84Super I/O specifics.
85For instance,
86.Xr fdc 4
87provides access to the floppy disk controller.
88.Pp
89There are other Super I/O devices that do not have any standardized interface.
90Drivers for those devices can be written using facilities of the
91.Nm
92driver.
93.Pp
94The driver itself attaches to the ISA bus as all supported controllers are
95accessed via LPC I/O ports.
96.Pp
97The
98.Nm
99driver is unusual as it is both a controller driver for a variety of Super I/O
100controllers and a bus driver for supported devices in those controllers.
101.Sh HARDWARE
102The
103.Nm
104driver supports a multitude of Super I/O controllers produced by Nuvoton,
105formerly known as Winbond, and ITE, namely:
106.Pp
107.Bl -bullet -compact
108.It
109Fintek F81803
110.It
111Fintek F81865
112.It
113Nuvoton NCT5104D/NCT6102D/NCT6106D rev. A and B+
114.It
115Nuvoton NCT5585D
116.It
117Nuvoton NCT6116D
118.It
119Nuvoton NCT6775
120.It
121Nuvoton NCT6776
122.It
123Nuvoton NCT6779
124.It
125Nuvoton NCT6791
126.It
127Nuvoton NCT6792
128.It
129Nuvoton NCT6793
130.It
131Nuvoton NCT6795
132.It
133Nuvoton NCT6796D-E
134.It
135Winbond 83627HF/F/HG/G/S/THF/EHF/DHG/UHG/DHG-P
136.It
137Winbond 83637HF
138.It
139Winbond 83667HG/HG-B
140.It
141Winbond 83687THF
142.It
143Winbond 83697HF/UG
144.El
145.Sh SEE ALSO
146.Xr superio 9
147.Sh HISTORY
148The
149.Nm
150driver was written by
151.An Andriy Gapon Aq Mt avg@FreeBSD.org .
152