xref: /freebsd/share/man/man4/atkbd.4 (revision 6e8394b8baa7d5d9153ab90de6824bcd19b3b4e1)
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.\" $Id: atkbd.4,v 1.4 1999/05/20 09:55:51 yokota Exp $
28.\"
29.Dd May 21, 1999
30.Dt ATKBD 4
31.Os FreeBSD
32.Sh NAME
33.Nm atkbd
34.Nd
35the AT keyboard interface
36.Sh SYNOPSIS
37.Cd "options ATKBD_DFLT_KEYMAP"
38.Cd "makeoptions ATKBD_DFLT_KEYMAP"=\&"_keymap_name_\&"
39.Cd "options KBD_DISABLE_KEYMAP_LOAD"
40.Cd "device atkbd0 at atkbdc? irq 1"
41.Sh DESCRIPTION
42The
43.Nm
44driver, together with the
45.Nm atkbdc
46driver, provides access to the AT 84 keyboard or the AT enhanced keyboard
47which is connected to the AT keyboard controller.
48.Pp
49This driver is required for the console drivers
50.Xr syscons 4
51and
52.Xr pcvt 4 .
53.Pp
54There can be only one
55.Nm
56device defined in the kernel configuration file.  This device also
57requires the
58.Nm atkbdc
59keyboard controller to be present.
60The
61.Em irq
62number must always be 1; there is no provision of changing the number.
63.Sh DRIVER CONFIGURATION
64.Ss Kernel Configuration Options
65The following kernel configuration options control the
66.Nm
67driver.
68.Bl -tag -width ATKBD_DFLT
69.It Em ATKBD_DFLT_KEYMAP
70This option sets the defauilt, built-in keymap of the
71.Nm
72driver to the named keymap.
73See
74.Sx EXAMPLE
75below.
76.It Em KBD_DISABLE_KEYMAP_LOAD
77The keymap can be modified by the
78.Xr kbdcontrol 1
79command.
80This option will disable this feature and prevent the user from
81changing key assignment.
82.El
83.Pp
84.Ss Driver Flags
85The
86.Nm
87driver accepts the following driver flags.  They can be set either in the
88kernel configuration file
89.Pq see Xr config 8 ,
90or else in the User Configuration Menu at boot time
91.Pq see Xr boot 8 .
92.Bl -tag -width FAIL
93.It bit 0 (FAIL_IF_NO_KBD)
94By default the
95.Nm
96driver will install even if a keyboard is not actually connected to the
97system.
98This option prevents the driver from being installed in this situation.
99.It bit 1 (NO_RESET)
100When this option is given, the
101.Nm
102driver will not reset the keyboard when initializing it.
103It may be useful for laptop computers whose function keys
104have special functions and these functions are forgotten when the
105keyboard is reset.
106.It bit 2 (ALT_SCANCODESET)
107Certain keyboards, such as those on some ThinkPad models, behave
108like the old XT keyboard and require this option.
109.El
110.\".Sh FILES
111.Sh EXAMPLE
112The
113.Nm
114driver requires the keyboard controller
115.Nm atkbdc .
116Thus, the kernel configuration file should contain the following lines.
117.Pp
118.Dl "device atkbdc0 at isa"
119.Dl "device atkbd0 at atkbdc? irq 1"
120.Pp
121The following example shows how to set the default, built-in keymap
122to
123.Pa jp.106.kbd .
124.Pp
125.Dl "options ATKBD_DFLT_KEYMAP"
126.Dl "makeoptions ATKBD_DFLT_KEYMAP"=\&"jp.106\&"
127.Dl "device atkbd0 at atkbdc? irq 1"
128.Pp
129.\".Sh DIAGNOSTICS
130.\".Sh CAVEATS
131.\".Sh BUGS
132.Sh SEE ALSO
133.Xr kbdcontrol 1 ,
134.Xr atkbdc 4 ,
135.Xr pcvt 4 ,
136.Xr psm 4 ,
137.Xr syscons 4 ,
138.Xr boot 8 ,
139.Xr config 8 .
140.Sh HISTORY
141The
142.Nm
143driver first appeared in
144.Fx 3.1 .
145.Sh AUTHORS
146The
147.Nm
148driver was written by
149.An S�ren Schmidt Aq sos@FreeBSD.org
150and
151.An Kazutaka Yokota Aq yokota@FreeBSD.org .
152This manual page was written by
153.An Kazutaka Yokota .
154