xref: /freebsd/share/man/man4/atkbd.4 (revision 7f3dea244c40159a41ab22da77a434d7c5b5e85a)
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 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.Ss Function Keys
64The AT keyboard has a number of function keys.
65They are numbered as follows and can be associated with strings
66by the
67.Xr kbdcontrol 1
68command.
69.Pp
70.Bl -tag -width "Function Key Number" -compact -offset
71.It "Function Key number"
72Function Key
73.It "1, 2,...12"
74F1, F2,... F12
75.It "13, 14,...24"
76Shift+F1, Shift+F2,... Shift+F12
77.It "25, 26,...36"
78Ctl+F1, Ctl+F2,... Ctl+F12
79.It "37, 38,...48"
80Shift+Ctl+F1, Shift+Ctl+F2,... Shift+Ctl+F12
81.It 49
82Home and Numpad 7 (without NumLock)
83.It 50
84Up Arrow and Numpad 8 (without NumLock)
85.It 51
86Page Up and Numpad 9 (without NumLock)
87.It 52
88Numpad -
89.It 53
90Left Arrow and Numpad 4 (without NumLock)
91.It 54
92Numpad 5 (without NumLock)
93.It 55
94Right Arrow and Numpad 6 (without NumLock)
95.It 56
96Numpad +
97.It 57
98End and Numpad 1 (without NumLock)
99.It 58
100Down Arrow and Numpad 2 (without NumLock)
101.It 59
102Page Down and Numpad 3 (without NumLock)
103.It 60
104Ins and Numpad 0 (without NumLock)
105.It 61
106Del
107.It 62
108Left GUI Key
109.It 63
110Right GUI Key
111.It 64
112Menu
113.El
114.Pp
115See the man page for the
116.Xr kbdcontrol 1
117command for how to assign a string to the function key.
118.Sh DRIVER CONFIGURATION
119.Ss Kernel Configuration Options
120The following kernel configuration options control the
121.Nm
122driver.
123.Bl -tag -width ATKBD_DFLT
124.It Em ATKBD_DFLT_KEYMAP
125This option sets the defauilt, built-in keymap of the
126.Nm
127driver to the named keymap.
128See
129.Sx EXAMPLE
130below.
131.It Em KBD_DISABLE_KEYMAP_LOAD
132The keymap can be modified by the
133.Xr kbdcontrol 1
134command.
135This option will disable this feature and prevent the user from
136changing key assignment.
137.El
138.Pp
139.Ss Driver Flags
140The
141.Nm
142driver accepts the following driver flags.  They can be set either in the
143kernel configuration file
144.Pq see Xr config 8 ,
145or else in the User Configuration Menu at boot time
146.Pq see Xr boot 8 .
147.Bl -tag -width FAIL
148.It bit 0 (FAIL_IF_NO_KBD)
149By default the
150.Nm
151driver will install even if a keyboard is not actually connected to the
152system.
153This option prevents the driver from being installed in this situation.
154.It bit 1 (NO_RESET)
155When this option is given, the
156.Nm
157driver will not reset the keyboard when initializing it.
158It may be useful for laptop computers whose function keys
159have special functions and these functions are forgotten when the
160keyboard is reset.
161.It bit 2 (ALT_SCANCODESET)
162Certain keyboards, such as those on some ThinkPad models, behave
163like the old XT keyboard and require this option.
164.El
165.\".Sh FILES
166.Sh EXAMPLE
167The
168.Nm
169driver requires the keyboard controller
170.Nm atkbdc .
171Thus, the kernel configuration file should contain the following lines.
172.Pp
173.Dl "device atkbdc0 at isa"
174.Dl "device atkbd0 at atkbdc? irq 1"
175.Pp
176The following example shows how to set the default, built-in keymap
177to
178.Pa jp.106.kbd .
179.Pp
180.Dl "options ATKBD_DFLT_KEYMAP"
181.Dl "makeoptions ATKBD_DFLT_KEYMAP"=\&"jp.106\&"
182.Dl "device atkbd0 at atkbdc? irq 1"
183.Pp
184.\".Sh DIAGNOSTICS
185.\".Sh CAVEATS
186.\".Sh BUGS
187.Sh SEE ALSO
188.Xr kbdcontrol 1 ,
189.Xr atkbdc 4 ,
190.Xr pcvt 4 ,
191.Xr psm 4 ,
192.Xr syscons 4 ,
193.Xr boot 8 ,
194.Xr config 8 .
195.Sh HISTORY
196The
197.Nm
198driver first appeared in
199.Fx 3.1 .
200.Sh AUTHORS
201The
202.Nm
203driver was written by
204.An S�ren Schmidt Aq sos@FreeBSD.org
205and
206.An Kazutaka Yokota Aq yokota@FreeBSD.org .
207This manual page was written by
208.An Kazutaka Yokota .
209