xref: /dragonfly/share/man/man4/atkbdc.4 (revision 71126e33)
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: src/share/man/man4/atkbdc.4,v 1.9.2.4 2001/08/17 13:08:37 ru Exp $
28.\" $DragonFly: src/share/man/man4/atkbdc.4,v 1.2 2003/06/17 04:36:58 dillon Exp $
29.\"
30.Dd February 9, 1999
31.Dt ATKBDC 4
32.Os
33.Sh NAME
34.Nm atkbdc
35.Nd the 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(see
61.Xr config 8 ) .
62.Bl -tag -width MOUSE
63.It Em KBD_RESETDELAY=X , KBD_MAXWAIT=Y
64The keyboard driver
65.Nm atkbd
66and the pointing device driver
67.Nm psm
68may ask the
69.Nm
70driver to reset these devices during the boot process.
71It sometimes takes a long time before these devices respond to
72the reset command.
73These options control how long the
74.Nm
75driver should
76wait before eventually giving up -- the driver will wait
77.Fa X
78*
79.Fa Y
80msecs at most.
81If the drivers seem unable to detect
82devices, you may want to increase these values.
83The default values are
84200 msec for
85.Fa X
86and 5
87for
88.Fa Y .
89.It Em KBDIO_DEBUG=N
90Sets the debug level to
91.Fa N .
92The default value is zero, which suppresses all debugging output.
93.El
94.\".Ss Driver Flags
95.\".Sh FILES
96.\".Sh EXAMPLE
97.\".Sh DIAGNOSTICS
98.\".Sh CAVEATS
99.\".Sh BUGS
100.Sh SEE ALSO
101.Xr atkbd 4 ,
102.Xr psm 4 ,
103.Xr config 8
104.Sh HISTORY
105The
106.Nm
107driver first appeared in
108.Fx 3.1 .
109It is based on the kbdio module in
110.Fx 2.2 .
111.Sh AUTHORS
112The kbdio module, the
113.Nm
114driver and this manual page were written by
115.An Kazutaka Yokota Aq yokota@FreeBSD.org .
116