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