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