xref: /freebsd/share/man/man4/atkbdc.4 (revision d9a42747950146bf03cda7f6e25d219253f8a57a)
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.\" $FreeBSD$
28.\"
29.Dd February 26, 2023
30.Dt ATKBDC 4
31.Os
32.Sh NAME
33.Nm atkbdc
34.Nd the AT keyboard controller interface
35.Sh SYNOPSIS
36.Cd "options KBD_RESETDELAY=N"
37.Cd "options KBD_MAXWAIT=N"
38.Cd "options KBD_DELAY1=N"
39.Cd "options KBD_DELAY2=N"
40.Cd "options KBDIO_DEBUG=N"
41.Cd "device atkbdc"
42.Pp
43In
44.Pa /boot/device.hints :
45.Cd hint.atkbdc.0.at="isa"
46.Cd hint.atkbdc.0.port="0x060"
47.Sh DESCRIPTION
48The keyboard controller
49.Nm
50provides I/O services for the AT keyboard and PS/2 mouse style
51pointing devices.
52This controller is required for the keyboard driver
53.Nm atkbd
54and the PS/2 pointing device driver
55.Nm psm .
56.Pp
57There can be only one
58.Nm
59device configured in the system.
60.Sh DRIVER CONFIGURATION
61.Ss Kernel Configuration Options
62The following kernel configuration options can be used to control the
63.Nm
64driver.
65They may be set in the kernel configuration file
66(see
67.Xr config 8 ) .
68.Bl -tag -width MOUSE
69.It Em KBD_RESETDELAY=X , KBD_MAXWAIT=Y
70The keyboard driver
71.Nm atkbd
72and the pointing device driver
73.Nm psm
74may ask the
75.Nm
76driver to reset these devices during the boot process.
77It sometimes takes a long time before these devices respond to
78the reset command.
79These options control how long the
80.Nm
81driver should
82wait before eventually giving up -- the driver will wait
83.Fa X
84*
85.Fa Y
86msecs at most.
87If the drivers seem unable to detect
88devices, you may want to increase these values.
89The default values are
90200 msec for
91.Fa X
92and 5
93for
94.Fa Y .
95.It Em KBD_DELAY1=X, KBD_DELAY2=Y
96DELAY1 sets the intitial key repeat delay to
97.Fa X .
98The default value is 500ms.
99DELAY2 sets the key repeat delay to
100.Fa Y .
101The default value is 100ms.
102.It Em KBDIO_DEBUG=N
103Sets the debug level to
104.Fa N .
105The default value is zero, which suppresses all debugging output.
106.El
107.\".Ss Driver Flags
108.\".Sh FILES
109.\".Sh EXAMPLE
110.\".Sh DIAGNOSTICS
111.\".Sh CAVEATS
112.\".Sh BUGS
113.Sh SEE ALSO
114.Xr atkbd 4 ,
115.Xr psm 4 ,
116.Xr config 8
117.Sh HISTORY
118The
119.Nm
120driver first appeared in
121.Fx 3.1 .
122It is based on the kbdio module in
123.Fx 2.2 .
124.Sh AUTHORS
125The kbdio module, the
126.Nm
127driver and this manual page were written by
128.An Kazutaka Yokota Aq Mt yokota@FreeBSD.org .
129