xref: /freebsd/share/man/man4/superio.4 (revision fa9896e082a1046ff4fbc75fcba4d18d1f2efc19)
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.Dd October 11, 2019
28c812bea3SAndriy Gapon.Dt SUPERIO 4
29c812bea3SAndriy Gapon.Os
30c812bea3SAndriy Gapon.Sh NAME
31c812bea3SAndriy Gapon.Nm superio
32c812bea3SAndriy Gapon.Nd Super I/O controller and bus driver
33c812bea3SAndriy Gapon.Sh SYNOPSIS
34c812bea3SAndriy GaponTo compile this driver into the kernel,
35c812bea3SAndriy Gaponplace the following line in your
36c812bea3SAndriy Gaponkernel configuration file:
37c812bea3SAndriy Gapon.Bd -ragged -offset indent
38c812bea3SAndriy Gapon.Cd "device superio"
39c812bea3SAndriy Gapon.Ed
40c812bea3SAndriy Gapon.Pp
41c812bea3SAndriy GaponAlternatively, to load the driver as a
42c812bea3SAndriy Gaponmodule at boot time, place the following line in
43c812bea3SAndriy Gapon.Xr loader.conf 5 :
44c812bea3SAndriy Gapon.Bd -literal -offset indent
45c812bea3SAndriy Gaponsuperio_load="YES"
46c812bea3SAndriy Gapon.Ed
47c812bea3SAndriy Gapon.Sh DESCRIPTION
48c812bea3SAndriy GaponSuper I/O is an I/O controller that combines various low-bandwidth devices
49c812bea3SAndriy Gaponthat can be functionally unrelated otherwise.
50c812bea3SAndriy GaponA typical Super I/O can contain devices such as
51*acb3e99fSChristian Brueffer.Pp
52c812bea3SAndriy Gapon.Bl -bullet -compact
53c812bea3SAndriy Gapon.It
54c812bea3SAndriy Gapona floppy disk controller
55c812bea3SAndriy Gapon.It
56c812bea3SAndriy Gapona parallel port
57c812bea3SAndriy Gapon.It
58c812bea3SAndriy Gapona serial port
59c812bea3SAndriy Gapon.It
60c812bea3SAndriy Gapona PS/2 mouse and keyboard controller
61c812bea3SAndriy Gapon.It
62c812bea3SAndriy Gapona hardware monitoring controller
63c812bea3SAndriy Gapon.It
64c812bea3SAndriy Gapona watchdog timer
65c812bea3SAndriy Gapon.It
66c812bea3SAndriy Gapona controller for general purpose input-output
67c812bea3SAndriy Gapon.El
68c812bea3SAndriy Gapon.Pp
69c812bea3SAndriy GaponThe
70c812bea3SAndriy Gapon.Nm
71c812bea3SAndriy Gapondriver provides support for devices residing in the Super I/O controller
72c812bea3SAndriy Gaponthat can only be accessed or discovered using the controller's interface.
73c812bea3SAndriy GaponSome of the Super I/O devices have standardized interfaces.
74c812bea3SAndriy GaponSuch devices either use well-known legacy resources or they are advertised
75c812bea3SAndriy Gaponvia ACPI or both.
76ba22e15cSAndriy GaponThey can be configured either using ISA bus hints or they are auto-configured by
77c812bea3SAndriy Gapon.Xr acpi 4 .
78c812bea3SAndriy GaponThe
79c812bea3SAndriy Gapon.Nm
80c812bea3SAndriy Gapondriver is not designed to interact with that kind of devices.
81c812bea3SAndriy GaponThey can be handled by their respective drivers without any knowledge of the
82c812bea3SAndriy GaponSuper I/O specifics.
83c812bea3SAndriy GaponFor instance,
84c812bea3SAndriy Gapon.Xr fdc 4
85c812bea3SAndriy Gaponprovides access to the floppy disk controller.
86c812bea3SAndriy Gapon.Pp
87c812bea3SAndriy GaponThere are other Super I/O devices that do not have any standardized interface.
88c812bea3SAndriy GaponDrivers for those devices can be written using facilities of the
89c812bea3SAndriy Gapon.Nm
90c812bea3SAndriy Gapondriver.
91c812bea3SAndriy Gapon.Pp
92c812bea3SAndriy GaponThe driver itself attaches to the ISA bus as all supported controllers are
93c812bea3SAndriy Gaponaccessed via LPC I/O ports.
94c812bea3SAndriy Gapon.Pp
95c812bea3SAndriy GaponThe
96c812bea3SAndriy Gapon.Nm
97c812bea3SAndriy Gapondriver is unusual as it is both a controller driver for a variety of Super I/O
98c812bea3SAndriy Gaponcontrollers and a bus driver for supported devices in those controllers.
99c812bea3SAndriy Gapon.Sh HARDWARE
100c812bea3SAndriy GaponThe
101c812bea3SAndriy Gapon.Nm
102c812bea3SAndriy Gapondriver supports a multitude of Super I/O controllers produced by Nuvoton,
103*acb3e99fSChristian Bruefferformerly known as Winbond, and ITE, namely:
104*acb3e99fSChristian Brueffer.Pp
1051b10e191SStéphane Rochoy.Bl -bullet -compact
1061b10e191SStéphane Rochoy.It
10732c3d315SStéphane RochoyFintek F81803
1081b10e191SStéphane Rochoy.It
10932c3d315SStéphane RochoyFintek F81865
11032c3d315SStéphane Rochoy.It
11132c3d315SStéphane RochoyNuvoton NCT5104D/NCT6102D/NCT6106D rev. A and B+
11232c3d315SStéphane Rochoy.It
1138e6ea10cSStéphane RochoyNuvoton NCT5585D
1148e6ea10cSStéphane Rochoy.It
1158e6ea10cSStéphane RochoyNuvoton NCT6116D
1168e6ea10cSStéphane Rochoy.It
11732c3d315SStéphane RochoyNuvoton NCT6775
11832c3d315SStéphane Rochoy.It
11932c3d315SStéphane RochoyNuvoton NCT6776
12032c3d315SStéphane Rochoy.It
12132c3d315SStéphane RochoyNuvoton NCT6779
12232c3d315SStéphane Rochoy.It
12332c3d315SStéphane RochoyNuvoton NCT6791
12432c3d315SStéphane Rochoy.It
12532c3d315SStéphane RochoyNuvoton NCT6792
12632c3d315SStéphane Rochoy.It
12732c3d315SStéphane RochoyNuvoton NCT6793
12832c3d315SStéphane Rochoy.It
12932c3d315SStéphane RochoyNuvoton NCT6795
13032c3d315SStéphane Rochoy.It
1318e6ea10cSStéphane RochoyNuvoton NCT6796D-E
1328e6ea10cSStéphane Rochoy.It
13332c3d315SStéphane RochoyWinbond 83627HF/F/HG/G/S/THF/EHF/DHG/UHG/DHG-P
13432c3d315SStéphane Rochoy.It
13532c3d315SStéphane RochoyWinbond 83637HF
13632c3d315SStéphane Rochoy.It
13732c3d315SStéphane RochoyWinbond 83667HG/HG-B
13832c3d315SStéphane Rochoy.It
13932c3d315SStéphane RochoyWinbond 83687THF
14032c3d315SStéphane Rochoy.It
14132c3d315SStéphane RochoyWinbond 83697HF/UG
1421b10e191SStéphane Rochoy.El
143c812bea3SAndriy Gapon.Sh SEE ALSO
144c812bea3SAndriy Gapon.Xr superio 9
145c812bea3SAndriy Gapon.Sh HISTORY
146c812bea3SAndriy GaponThe
147c812bea3SAndriy Gapon.Nm
148c812bea3SAndriy Gapondriver was written by
149c812bea3SAndriy Gapon.An Andriy Gapon Aq Mt avg@FreeBSD.org .
150