xref: /freebsd/share/man/man4/atkbdc.4 (revision ffc4f93e960d38b6f70d59409127f7562e40f916)
1.\"
2.\" Copyright (c) 1999
3.\" Kazutaka YOKOTA <yokota@zodiac.mech.utsunomiya-u.ac.jp>
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 as
11.\"    the first lines of this file unmodified.
12.\" 2. Redistributions in binary form must reproduce the above copyright
13.\"    notice, this list of conditions and the following disclaimer in the
14.\"    documentation and/or other materials provided with the distribution.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26.\"
27.Dd February 26, 2023
28.Dt ATKBDC 4
29.Os
30.Sh NAME
31.Nm atkbdc
32.Nd the AT keyboard controller interface
33.Sh SYNOPSIS
34.Cd "options KBD_RESETDELAY=N"
35.Cd "options KBD_MAXWAIT=N"
36.Cd "options KBD_DELAY1=N"
37.Cd "options KBD_DELAY2=N"
38.Cd "options KBDIO_DEBUG=N"
39.Cd "device atkbdc"
40.Pp
41In
42.Pa /boot/device.hints :
43.Cd hint.atkbdc.0.at="isa"
44.Cd hint.atkbdc.0.port="0x060"
45.Sh DESCRIPTION
46The keyboard controller
47.Nm
48provides I/O services for the AT keyboard and PS/2 mouse style
49pointing devices.
50This controller is required for the keyboard driver
51.Nm atkbd
52and the PS/2 pointing device driver
53.Nm psm .
54.Pp
55There can be only one
56.Nm
57device configured in the system.
58.Sh DRIVER CONFIGURATION
59.Ss Kernel Configuration Options
60The following kernel configuration options can be used to control the
61.Nm
62driver.
63They may be set in the kernel configuration file
64(see
65.Xr config 8 ) .
66.Bl -tag -width MOUSE
67.It Em KBD_RESETDELAY=X , KBD_MAXWAIT=Y
68The keyboard driver
69.Nm atkbd
70and the pointing device driver
71.Nm psm
72may ask the
73.Nm
74driver to reset these devices during the boot process.
75It sometimes takes a long time before these devices respond to
76the reset command.
77These options control how long the
78.Nm
79driver should
80wait before eventually giving up -- the driver will wait
81.Fa X
82*
83.Fa Y
84msecs at most.
85If the drivers seem unable to detect
86devices, you may want to increase these values.
87The default values are
88200 msec for
89.Fa X
90and 5
91for
92.Fa Y .
93.It Em KBD_DELAY1=X, KBD_DELAY2=Y
94DELAY1 sets the initial key repeat delay to
95.Fa X .
96The default value is 500ms.
97DELAY2 sets the key repeat delay to
98.Fa Y .
99The default value is 100ms.
100.It Em KBDIO_DEBUG=N
101Sets the debug level to
102.Fa N .
103The default value is zero, which suppresses all debugging output.
104.El
105.\".Ss Driver Flags
106.\".Sh FILES
107.\".Sh EXAMPLE
108.\".Sh DIAGNOSTICS
109.\".Sh CAVEATS
110.\".Sh BUGS
111.Sh SEE ALSO
112.Xr atkbd 4 ,
113.Xr psm 4 ,
114.Xr config 8
115.Sh HISTORY
116The
117.Nm
118driver first appeared in
119.Fx 3.1 .
120It is based on the kbdio module in
121.Fx 2.2 .
122.Sh AUTHORS
123The kbdio module, the
124.Nm
125driver and this manual page were written by
126.An Kazutaka Yokota Aq Mt yokota@FreeBSD.org .
127