xref: /freebsd/share/man/man4/superio.4 (revision 8e6ea10c31220b5f56dbd966a0ee7163d46d30d1)
1c812bea3SAndriy Gapon.\"
24d846d26SWarner Losh.\" SPDX-License-Identifier: BSD-2-Clause
3c812bea3SAndriy Gapon.\"
4c812bea3SAndriy Gapon.\" Copyright (c) 2019 Andriy Gapon <avg@FreeBSD.org>
5c812bea3SAndriy Gapon.\"
6c812bea3SAndriy Gapon.\" Redistribution and use in source and binary forms, with or without
7c812bea3SAndriy Gapon.\" modification, are permitted provided that the following conditions
8c812bea3SAndriy Gapon.\" are met:
9c812bea3SAndriy Gapon.\" 1. Redistributions of source code must retain the above copyright
10c812bea3SAndriy Gapon.\"    notice, this list of conditions and the following disclaimer.
11c812bea3SAndriy Gapon.\" 2. Redistributions in binary form must reproduce the above copyright
12c812bea3SAndriy Gapon.\"    notice, this list of conditions and the following disclaimer in the
13c812bea3SAndriy Gapon.\"    documentation and/or other materials provided with the distribution.
14c812bea3SAndriy Gapon.\"
15c812bea3SAndriy Gapon.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16c812bea3SAndriy Gapon.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17c812bea3SAndriy Gapon.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18c812bea3SAndriy Gapon.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19c812bea3SAndriy Gapon.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20c812bea3SAndriy Gapon.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21c812bea3SAndriy Gapon.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22c812bea3SAndriy Gapon.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23c812bea3SAndriy Gapon.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24c812bea3SAndriy Gapon.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25c812bea3SAndriy Gapon.\" SUCH DAMAGE.
26c812bea3SAndriy Gapon.\"
27c812bea3SAndriy Gapon.\" $FreeBSD$
28c812bea3SAndriy Gapon.\"
29c812bea3SAndriy Gapon.Dd October 11, 2019
30c812bea3SAndriy Gapon.Dt SUPERIO 4
31c812bea3SAndriy Gapon.Os
32c812bea3SAndriy Gapon.Sh NAME
33c812bea3SAndriy Gapon.Nm superio
34c812bea3SAndriy Gapon.Nd Super I/O controller and bus driver
35c812bea3SAndriy Gapon.Sh SYNOPSIS
36c812bea3SAndriy GaponTo compile this driver into the kernel,
37c812bea3SAndriy Gaponplace the following line in your
38c812bea3SAndriy Gaponkernel configuration file:
39c812bea3SAndriy Gapon.Bd -ragged -offset indent
40c812bea3SAndriy Gapon.Cd "device superio"
41c812bea3SAndriy Gapon.Ed
42c812bea3SAndriy Gapon.Pp
43c812bea3SAndriy GaponAlternatively, to load the driver as a
44c812bea3SAndriy Gaponmodule at boot time, place the following line in
45c812bea3SAndriy Gapon.Xr loader.conf 5 :
46c812bea3SAndriy Gapon.Bd -literal -offset indent
47c812bea3SAndriy Gaponsuperio_load="YES"
48c812bea3SAndriy Gapon.Ed
49c812bea3SAndriy Gapon.Sh DESCRIPTION
50c812bea3SAndriy GaponSuper I/O is an I/O controller that combines various low-bandwidth devices
51c812bea3SAndriy Gaponthat can be functionally unrelated otherwise.
52c812bea3SAndriy GaponA typical Super I/O can contain devices such as
53c812bea3SAndriy Gapon.Bl -bullet -compact
54c812bea3SAndriy Gapon.It
55c812bea3SAndriy Gapona floppy disk controller
56c812bea3SAndriy Gapon.It
57c812bea3SAndriy Gapona parallel port
58c812bea3SAndriy Gapon.It
59c812bea3SAndriy Gapona serial port
60c812bea3SAndriy Gapon.It
61c812bea3SAndriy Gapona PS/2 mouse and keyboard controller
62c812bea3SAndriy Gapon.It
63c812bea3SAndriy Gapona hardware monitoring controller
64c812bea3SAndriy Gapon.It
65c812bea3SAndriy Gapona watchdog timer
66c812bea3SAndriy Gapon.It
67c812bea3SAndriy Gapona controller for general purpose input-output
68c812bea3SAndriy Gapon.El
69c812bea3SAndriy Gapon.Pp
70c812bea3SAndriy GaponThe
71c812bea3SAndriy Gapon.Nm
72c812bea3SAndriy Gapondriver provides support for devices residing in the Super I/O controller
73c812bea3SAndriy Gaponthat can only be accessed or discovered using the controller's interface.
74c812bea3SAndriy GaponSome of the Super I/O devices have standardized interfaces.
75c812bea3SAndriy GaponSuch devices either use well-known legacy resources or they are advertised
76c812bea3SAndriy Gaponvia ACPI or both.
77ba22e15cSAndriy GaponThey can be configured either using ISA bus hints or they are auto-configured by
78c812bea3SAndriy Gapon.Xr acpi 4 .
79c812bea3SAndriy GaponThe
80c812bea3SAndriy Gapon.Nm
81c812bea3SAndriy Gapondriver is not designed to interact with that kind of devices.
82c812bea3SAndriy GaponThey can be handled by their respective drivers without any knowledge of the
83c812bea3SAndriy GaponSuper I/O specifics.
84c812bea3SAndriy GaponFor instance,
85c812bea3SAndriy Gapon.Xr fdc 4
86c812bea3SAndriy Gaponprovides access to the floppy disk controller.
87c812bea3SAndriy Gapon.Pp
88c812bea3SAndriy GaponThere are other Super I/O devices that do not have any standardized interface.
89c812bea3SAndriy GaponDrivers for those devices can be written using facilities of the
90c812bea3SAndriy Gapon.Nm
91c812bea3SAndriy Gapondriver.
92c812bea3SAndriy Gapon.Pp
93c812bea3SAndriy GaponThe driver itself attaches to the ISA bus as all supported controllers are
94c812bea3SAndriy Gaponaccessed via LPC I/O ports.
95c812bea3SAndriy Gapon.Pp
96c812bea3SAndriy GaponThe
97c812bea3SAndriy Gapon.Nm
98c812bea3SAndriy Gapondriver is unusual as it is both a controller driver for a variety of Super I/O
99c812bea3SAndriy Gaponcontrollers and a bus driver for supported devices in those controllers.
100c812bea3SAndriy Gapon.Sh HARDWARE
101c812bea3SAndriy GaponThe
102c812bea3SAndriy Gapon.Nm
103c812bea3SAndriy Gapondriver supports a multitude of Super I/O controllers produced by Nuvoton,
10432c3d315SStéphane Rochoyformerly known as Winbond, and ITE. Namely:
1051b10e191SStéphane Rochoy
1061b10e191SStéphane Rochoy.Bl -bullet -compact
1071b10e191SStéphane Rochoy.It
10832c3d315SStéphane RochoyFintek F81803
1091b10e191SStéphane Rochoy.It
11032c3d315SStéphane RochoyFintek F81865
11132c3d315SStéphane Rochoy.It
11232c3d315SStéphane RochoyNuvoton NCT5104D/NCT6102D/NCT6106D rev. A and B+
11332c3d315SStéphane Rochoy.It
114*8e6ea10cSStéphane RochoyNuvoton NCT5585D
115*8e6ea10cSStéphane Rochoy.It
116*8e6ea10cSStéphane RochoyNuvoton NCT6116D
117*8e6ea10cSStéphane Rochoy.It
11832c3d315SStéphane RochoyNuvoton NCT6775
11932c3d315SStéphane Rochoy.It
12032c3d315SStéphane RochoyNuvoton NCT6776
12132c3d315SStéphane Rochoy.It
12232c3d315SStéphane RochoyNuvoton NCT6779
12332c3d315SStéphane Rochoy.It
12432c3d315SStéphane RochoyNuvoton NCT6791
12532c3d315SStéphane Rochoy.It
12632c3d315SStéphane RochoyNuvoton NCT6792
12732c3d315SStéphane Rochoy.It
12832c3d315SStéphane RochoyNuvoton NCT6793
12932c3d315SStéphane Rochoy.It
13032c3d315SStéphane RochoyNuvoton NCT6795
13132c3d315SStéphane Rochoy.It
132*8e6ea10cSStéphane RochoyNuvoton NCT6796D-E
133*8e6ea10cSStéphane Rochoy.It
13432c3d315SStéphane RochoyWinbond 83627HF/F/HG/G/S/THF/EHF/DHG/UHG/DHG-P
13532c3d315SStéphane Rochoy.It
13632c3d315SStéphane RochoyWinbond 83637HF
13732c3d315SStéphane Rochoy.It
13832c3d315SStéphane RochoyWinbond 83667HG/HG-B
13932c3d315SStéphane Rochoy.It
14032c3d315SStéphane RochoyWinbond 83687THF
14132c3d315SStéphane Rochoy.It
14232c3d315SStéphane RochoyWinbond 83697HF/UG
1431b10e191SStéphane Rochoy.El
1441b10e191SStéphane Rochoy
145c812bea3SAndriy Gapon.Sh SEE ALSO
146c812bea3SAndriy Gapon.Xr superio 9
147c812bea3SAndriy Gapon.Sh HISTORY
148c812bea3SAndriy GaponThe
149c812bea3SAndriy Gapon.Nm
150c812bea3SAndriy Gapondriver was written by
151c812bea3SAndriy Gapon.An Andriy Gapon Aq Mt avg@FreeBSD.org .
152