2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 1999 Kazutaka YOKOTA <yokota@zodiac.mech.utsunomiya-u.ac.jp>
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer as
12 * the first lines of this file unmodified.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR
18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT,
21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 #include <sys/cdefs.h>
31 __FBSDID("$FreeBSD$");
34 #include "opt_atkbd.h"
35 #include "opt_evdev.h"
37 #include <sys/param.h>
38 #include <sys/systm.h>
39 #include <sys/kernel.h>
41 #include <sys/eventhandler.h>
43 #include <sys/limits.h>
44 #include <sys/malloc.h>
46 #include <machine/bus.h>
47 #include <machine/resource.h>
50 #include <dev/kbd/kbdreg.h>
51 #include <dev/atkbdc/atkbdreg.h>
52 #include <dev/atkbdc/atkbdcreg.h>
55 #include <dev/evdev/evdev.h>
56 #include <dev/evdev/input.h>
59 typedef struct atkbd_state {
60 KBDC kbdc; /* keyboard controller */
61 int ks_mode; /* input mode (K_XLATE,K_RAW,K_CODE) */
62 int ks_flags; /* flags */
63 #define COMPOSE (1 << 0)
65 int ks_state; /* shift/lock key state */
66 int ks_accents; /* accent key index (> 0) */
67 u_int ks_composed_char; /* composed char code (> 0) */
68 u_char ks_prefix; /* AT scan code prefix */
69 struct callout ks_timer;
71 struct evdev_dev *ks_evdev;
76 static void atkbd_timeout(void *arg);
77 static int atkbd_reset(KBDC kbdc, int flags, int c);
79 #define HAS_QUIRK(p, q) (((atkbdc_softc_t *)(p))->quirks & q)
80 #define ALLOW_DISABLE_KBD(kbdc) !HAS_QUIRK(kbdc, KBDC_QUIRK_KEEP_ACTIVATED)
82 #define DEFAULT_DELAY 0x1 /* 500ms */
83 #define DEFAULT_RATE 0x10 /* 14Hz */
86 #define PS2_KEYBOARD_VENDOR 1
87 #define PS2_KEYBOARD_PRODUCT 1
91 atkbd_probe_unit(device_t dev, int irq, int flags)
93 keyboard_switch_t *sw;
97 sw = kbd_get_switch(ATKBD_DRIVER_NAME);
101 args[0] = device_get_unit(device_get_parent(dev));
103 error = (*sw->probe)(device_get_unit(dev), args, flags);
110 atkbd_attach_unit(device_t dev, keyboard_t **kbd, int irq, int flags)
112 keyboard_switch_t *sw;
113 atkbd_state_t *state;
118 sw = kbd_get_switch(ATKBD_DRIVER_NAME);
122 /* reset, initialize and enable the device */
123 unit = device_get_unit(dev);
124 args[0] = device_get_unit(device_get_parent(dev));
127 error = (*sw->probe)(unit, args, flags);
130 error = (*sw->init)(unit, kbd, args, flags);
135 #ifdef KBD_INSTALL_CDEV
136 /* attach a virtual keyboard cdev */
137 error = kbd_attach(*kbd);
143 * This is a kludge to compensate for lost keyboard interrupts.
144 * A similar code used to be in syscons. See below. XXX
146 state = (atkbd_state_t *)(*kbd)->kb_data;
147 callout_init(&state->ks_timer, 0);
151 (*sw->diag)(*kbd, bootverbose);
157 atkbd_timeout(void *arg)
159 atkbd_state_t *state;
164 * The original text of the following comments are extracted
165 * from syscons.c (1.287)
167 * With release 2.1 of the Xaccel server, the keyboard is left
168 * hanging pretty often. Apparently an interrupt from the
169 * keyboard is lost, and I don't know why (yet).
170 * This ugly hack calls the low-level interrupt routine if input
171 * is ready for the keyboard and conveniently hides the problem. XXX
173 * Try removing anything stuck in the keyboard controller; whether
174 * it's a keyboard scan code or mouse data. The low-level
175 * interrupt routine doesn't read the mouse data directly,
176 * but the keyboard controller driver will, as a side effect.
179 * And here is bde's original comment about this:
181 * This is necessary to handle edge triggered interrupts - if we
182 * returned when our IRQ is high due to unserviced input, then there
183 * would be no more keyboard IRQs until the keyboard is reset by
186 * The keyboard apparently unwedges the irq in most cases.
189 kbd = (keyboard_t *)arg;
190 if (kbdd_lock(kbd, TRUE)) {
192 * We have seen the lock flag is not set. Let's reset
193 * the flag early, otherwise the LED update routine fails
194 * which may want the lock during the interrupt routine.
196 kbdd_lock(kbd, FALSE);
197 if (kbdd_check_char(kbd))
198 kbdd_intr(kbd, NULL);
201 state = (atkbd_state_t *)kbd->kb_data;
202 callout_reset(&state->ks_timer, hz / 10, atkbd_timeout, arg);
207 #define ATKBD_DEFAULT 0
209 /* keyboard driver declaration */
210 static int atkbd_configure(int flags);
211 static kbd_probe_t atkbd_probe;
212 static kbd_init_t atkbd_init;
213 static kbd_term_t atkbd_term;
214 static kbd_intr_t atkbd_intr;
215 static kbd_test_if_t atkbd_test_if;
216 static kbd_enable_t atkbd_enable;
217 static kbd_disable_t atkbd_disable;
218 static kbd_read_t atkbd_read;
219 static kbd_check_t atkbd_check;
220 static kbd_read_char_t atkbd_read_char;
221 static kbd_check_char_t atkbd_check_char;
222 static kbd_ioctl_t atkbd_ioctl;
223 static kbd_lock_t atkbd_lock;
224 static kbd_clear_state_t atkbd_clear_state;
225 static kbd_get_state_t atkbd_get_state;
226 static kbd_set_state_t atkbd_set_state;
227 static kbd_poll_mode_t atkbd_poll;
229 static keyboard_switch_t atkbdsw = {
230 .probe = atkbd_probe,
234 .test_if = atkbd_test_if,
235 .enable = atkbd_enable,
236 .disable = atkbd_disable,
238 .check = atkbd_check,
239 .read_char = atkbd_read_char,
240 .check_char = atkbd_check_char,
241 .ioctl = atkbd_ioctl,
243 .clear_state = atkbd_clear_state,
244 .get_state = atkbd_get_state,
245 .set_state = atkbd_set_state,
249 KEYBOARD_DRIVER(atkbd, atkbdsw, atkbd_configure);
251 /* local functions */
252 static int set_typematic(keyboard_t *kbd);
253 static int setup_kbd_port(KBDC kbdc, int port, int intr);
254 static int get_kbd_echo(KBDC kbdc);
255 static int probe_keyboard(KBDC kbdc, int flags);
256 static int init_keyboard(KBDC kbdc, int *type, int flags);
257 static int write_kbd(KBDC kbdc, int command, int data);
258 static int get_kbd_id(KBDC kbdc);
259 static int typematic(int delay, int rate);
260 static int typematic_delay(int delay);
261 static int typematic_rate(int rate);
264 static evdev_event_t atkbd_ev_event;
266 static const struct evdev_methods atkbd_evdev_methods = {
267 .ev_event = atkbd_ev_event,
271 /* local variables */
273 /* the initial key map, accent map and fkey strings */
274 #ifdef ATKBD_DFLT_KEYMAP
275 #define KBD_DFLT_KEYMAP
276 #include "atkbdmap.h"
278 #include <dev/kbd/kbdtables.h>
280 /* structures for the default keyboard */
281 static keyboard_t default_kbd;
282 static atkbd_state_t default_kbd_state;
283 static keymap_t default_keymap;
284 static accentmap_t default_accentmap;
285 static fkeytab_t default_fkeytab[NUM_FKEYS];
288 * The back door to the keyboard driver!
289 * This function is called by the console driver, via the kbdio module,
290 * to tickle keyboard drivers when the low-level console is being initialized.
291 * Almost nothing in the kernel has been initialied yet. Try to probe
292 * keyboards if possible.
293 * NOTE: because of the way the low-level console is initialized, this routine
294 * may be called more than once!!
297 atkbd_configure(int flags)
304 * Probe the keyboard controller, if not present or if the driver
305 * is disabled, unregister the keyboard if any.
307 if (atkbdc_configure() != 0 ||
308 resource_disabled("atkbd", ATKBD_DEFAULT)) {
309 i = kbd_find_keyboard(ATKBD_DRIVER_NAME, ATKBD_DEFAULT);
311 kbd = kbd_get_keyboard(i);
313 kbd->kb_flags &= ~KB_REGISTERED;
318 /* XXX: a kludge to obtain the device configuration flags */
319 if (resource_int_value("atkbd", ATKBD_DEFAULT, "flags", &i) == 0)
322 /* probe the default keyboard */
326 if (atkbd_probe(ATKBD_DEFAULT, arg, flags))
328 if (atkbd_init(ATKBD_DEFAULT, &kbd, arg, flags))
331 /* return the number of found keyboards */
335 /* low-level functions */
337 /* detect a keyboard */
339 atkbd_probe(int unit, void *arg, int flags)
342 int *data = (int *)arg; /* data[0]: controller, data[1]: irq */
345 if (unit == ATKBD_DEFAULT) {
346 if (KBD_IS_PROBED(&default_kbd))
350 kbdc = atkbdc_open(data[0]);
353 if (probe_keyboard(kbdc, flags)) {
354 if (flags & KB_CONF_FAIL_IF_NO_KBD)
360 /* reset and initialize the device */
362 atkbd_init(int unit, keyboard_t **kbdp, void *arg, int flags)
365 atkbd_state_t *state;
371 int *data = (int *)arg; /* data[0]: controller, data[1]: irq */
374 struct evdev_dev *evdev;
379 if (unit == ATKBD_DEFAULT) {
380 *kbdp = kbd = &default_kbd;
381 if (KBD_IS_INITIALIZED(kbd) && KBD_IS_CONFIGURED(kbd))
383 state = &default_kbd_state;
384 keymap = &default_keymap;
385 accmap = &default_accentmap;
386 fkeymap = default_fkeytab;
387 fkeymap_size = nitems(default_fkeytab);
389 } else if (*kbdp == NULL) {
390 *kbdp = kbd = malloc(sizeof(*kbd), M_DEVBUF, M_NOWAIT | M_ZERO);
391 state = malloc(sizeof(*state), M_DEVBUF, M_NOWAIT | M_ZERO);
392 /* NB: these will always be initialized 'cuz !KBD_IS_PROBED */
393 keymap = malloc(sizeof(key_map), M_DEVBUF, M_NOWAIT);
394 accmap = malloc(sizeof(accent_map), M_DEVBUF, M_NOWAIT);
395 fkeymap = malloc(sizeof(fkey_tab), M_DEVBUF, M_NOWAIT);
396 fkeymap_size = sizeof(fkey_tab)/sizeof(fkey_tab[0]);
398 if ((kbd == NULL) || (state == NULL) || (keymap == NULL)
399 || (accmap == NULL) || (fkeymap == NULL)) {
403 } else if (KBD_IS_INITIALIZED(*kbdp) && KBD_IS_CONFIGURED(*kbdp)) {
407 state = (atkbd_state_t *)kbd->kb_data;
408 bzero(state, sizeof(*state));
409 keymap = kbd->kb_keymap;
410 accmap = kbd->kb_accentmap;
411 fkeymap = kbd->kb_fkeytab;
412 fkeymap_size = kbd->kb_fkeytab_size;
416 if (!KBD_IS_PROBED(kbd)) {
417 state->kbdc = atkbdc_open(data[0]);
418 if (state->kbdc == NULL) {
422 kbd_init_struct(kbd, ATKBD_DRIVER_NAME, KB_OTHER, unit, flags,
424 bcopy(&key_map, keymap, sizeof(key_map));
425 bcopy(&accent_map, accmap, sizeof(accent_map));
426 bcopy(fkey_tab, fkeymap,
427 imin(fkeymap_size * sizeof(fkeymap[0]), sizeof(fkey_tab)));
428 kbd_set_maps(kbd, keymap, accmap, fkeymap, fkeymap_size);
429 kbd->kb_data = (void *)state;
431 if (probe_keyboard(state->kbdc, flags)) { /* shouldn't happen */
432 if (flags & KB_CONF_FAIL_IF_NO_KBD) {
437 KBD_FOUND_DEVICE(kbd);
439 atkbd_clear_state(kbd);
440 state->ks_mode = K_XLATE;
442 * FIXME: set the initial value for lock keys in ks_state
443 * according to the BIOS data?
447 if (!KBD_IS_INITIALIZED(kbd) && !(flags & KB_CONF_PROBE_ONLY)) {
448 kbd->kb_config = flags & ~KB_CONF_PROBE_ONLY;
449 if (KBD_HAS_DEVICE(kbd)
450 && init_keyboard(state->kbdc, &kbd->kb_type, kbd->kb_config)
451 && (kbd->kb_config & KB_CONF_FAIL_IF_NO_KBD)) {
456 atkbd_ioctl(kbd, KDSETLED, (caddr_t)&state->ks_state);
458 delay[0] = kbd->kb_delay1;
459 delay[1] = kbd->kb_delay2;
460 atkbd_ioctl(kbd, KDSETREPEAT, (caddr_t)delay);
463 /* register as evdev provider on first init */
464 if (state->ks_evdev == NULL) {
465 snprintf(phys_loc, sizeof(phys_loc), "atkbd%d", unit);
466 evdev = evdev_alloc();
467 evdev_set_name(evdev, "AT keyboard");
468 evdev_set_phys(evdev, phys_loc);
469 evdev_set_id(evdev, BUS_I8042, PS2_KEYBOARD_VENDOR,
470 PS2_KEYBOARD_PRODUCT, 0);
471 evdev_set_methods(evdev, kbd, &atkbd_evdev_methods);
472 evdev_support_event(evdev, EV_SYN);
473 evdev_support_event(evdev, EV_KEY);
474 evdev_support_event(evdev, EV_LED);
475 evdev_support_event(evdev, EV_REP);
476 evdev_support_all_known_keys(evdev);
477 evdev_support_led(evdev, LED_NUML);
478 evdev_support_led(evdev, LED_CAPSL);
479 evdev_support_led(evdev, LED_SCROLLL);
481 if (evdev_register_mtx(evdev, &Giant))
484 state->ks_evdev = evdev;
485 state->ks_evdev_state = 0;
491 if (!KBD_IS_CONFIGURED(kbd)) {
492 if (kbd_register(kbd) < 0) {
496 KBD_CONFIG_DONE(kbd);
503 free(state, M_DEVBUF);
505 free(keymap, M_DEVBUF);
507 free(accmap, M_DEVBUF);
509 free(fkeymap, M_DEVBUF);
512 *kbdp = NULL; /* insure ref doesn't leak to caller */
518 /* finish using this keyboard */
520 atkbd_term(keyboard_t *kbd)
522 atkbd_state_t *state = (atkbd_state_t *)kbd->kb_data;
525 callout_drain(&state->ks_timer);
529 /* keyboard interrupt routine */
531 atkbd_intr(keyboard_t *kbd, void *arg)
533 atkbd_state_t *state = (atkbd_state_t *)kbd->kb_data;
537 if (!KBD_HAS_DEVICE(kbd)) {
539 * The keyboard was not detected before;
540 * it must have been reconnected!
542 init_keyboard(state->kbdc, &kbd->kb_type, kbd->kb_config);
543 KBD_FOUND_DEVICE(kbd);
544 atkbd_ioctl(kbd, KDSETLED, (caddr_t)&state->ks_state);
546 delay[0] = kbd->kb_delay1;
547 delay[1] = kbd->kb_delay2;
548 atkbd_ioctl(kbd, KDSETREPEAT, (caddr_t)delay);
551 if (state->ks_polling)
554 if (KBD_IS_ACTIVE(kbd) && KBD_IS_BUSY(kbd)) {
555 /* let the callback function to process the input */
556 (*kbd->kb_callback.kc_func)(kbd, KBDIO_KEYINPUT,
557 kbd->kb_callback.kc_arg);
559 /* read and discard the input; no one is waiting for input */
561 c = atkbd_read_char(kbd, FALSE);
562 } while (c != NOKEY);
567 /* test the interface to the device */
569 atkbd_test_if(keyboard_t *kbd)
575 empty_both_buffers(((atkbd_state_t *)kbd->kb_data)->kbdc, 10);
577 if (!test_controller(((atkbd_state_t *)kbd->kb_data)->kbdc))
579 else if (test_kbd_port(((atkbd_state_t *)kbd->kb_data)->kbdc) != 0)
587 * Enable the access to the device; until this function is called,
588 * the client cannot read from the keyboard.
591 atkbd_enable(keyboard_t *kbd)
601 /* disallow the access to the device */
603 atkbd_disable(keyboard_t *kbd)
613 /* read one byte from the keyboard if it's allowed */
615 atkbd_read(keyboard_t *kbd, int wait)
620 c = read_kbd_data(((atkbd_state_t *)kbd->kb_data)->kbdc);
622 c = read_kbd_data_no_wait(((atkbd_state_t *)kbd->kb_data)->kbdc);
625 return (KBD_IS_ACTIVE(kbd) ? c : -1);
628 /* check if data is waiting */
630 atkbd_check(keyboard_t *kbd)
632 if (!KBD_IS_ACTIVE(kbd))
634 return kbdc_data_ready(((atkbd_state_t *)kbd->kb_data)->kbdc);
637 /* read char from the keyboard */
639 atkbd_read_char(keyboard_t *kbd, int wait)
641 atkbd_state_t *state;
646 state = (atkbd_state_t *)kbd->kb_data;
648 /* do we have a composed char to return? */
649 if (!(state->ks_flags & COMPOSE) && (state->ks_composed_char > 0)) {
650 action = state->ks_composed_char;
651 state->ks_composed_char = 0;
652 if (action > UCHAR_MAX)
657 /* see if there is something in the keyboard port */
660 scancode = read_kbd_data(state->kbdc);
661 } while (scancode == -1);
663 scancode = read_kbd_data_no_wait(state->kbdc);
669 #if KBDIO_DEBUG >= 10
670 printf("atkbd_read_char(): scancode:0x%x\n", scancode);
674 /* push evdev event */
675 if (evdev_rcpt_mask & EVDEV_RCPT_HW_KBD && state->ks_evdev != NULL) {
676 keycode = evdev_scancode2key(&state->ks_evdev_state,
679 if (keycode != KEY_RESERVED) {
680 evdev_push_event(state->ks_evdev, EV_KEY,
681 (uint16_t)keycode, scancode & 0x80 ? 0 : 1);
682 evdev_sync(state->ks_evdev);
687 /* return the byte as is for the K_RAW mode */
688 if (state->ks_mode == K_RAW)
691 /* translate the scan code into a keycode */
692 keycode = scancode & 0x7F;
693 switch (state->ks_prefix) {
694 case 0x00: /* normal scancode */
696 case 0xB8: /* left alt (compose key) released */
697 if (state->ks_flags & COMPOSE) {
698 state->ks_flags &= ~COMPOSE;
699 if (state->ks_composed_char > UCHAR_MAX)
700 state->ks_composed_char = 0;
703 case 0x38: /* left alt (compose key) pressed */
704 if (!(state->ks_flags & COMPOSE)) {
705 state->ks_flags |= COMPOSE;
706 state->ks_composed_char = 0;
711 state->ks_prefix = scancode;
715 case 0xE0: /* 0xE0 prefix */
716 state->ks_prefix = 0;
718 case 0x1C: /* right enter key */
721 case 0x1D: /* right ctrl key */
724 case 0x35: /* keypad divide key */
727 case 0x37: /* print scrn key */
730 case 0x38: /* right alt key (alt gr) */
733 case 0x46: /* ctrl-pause/break on AT 101 (see below) */
736 case 0x47: /* grey home key */
739 case 0x48: /* grey up arrow key */
742 case 0x49: /* grey page up key */
745 case 0x4B: /* grey left arrow key */
748 case 0x4D: /* grey right arrow key */
751 case 0x4F: /* grey end key */
754 case 0x50: /* grey down arrow key */
757 case 0x51: /* grey page down key */
760 case 0x52: /* grey insert key */
763 case 0x53: /* grey delete key */
766 /* the following 3 are only used on the MS "Natural" keyboard */
767 case 0x5b: /* left Window key */
770 case 0x5c: /* right Window key */
773 case 0x5d: /* menu key */
776 case 0x5e: /* power key */
779 case 0x5f: /* sleep key */
782 case 0x63: /* wake key */
785 default: /* ignore everything else */
789 case 0xE1: /* 0xE1 prefix */
791 * The pause/break key on the 101 keyboard produces:
793 * Ctrl-pause/break produces:
794 * E0-46 E0-C6 (See above.)
796 state->ks_prefix = 0;
798 state->ks_prefix = 0x1D;
801 case 0x1D: /* pause / break */
802 state->ks_prefix = 0;
809 if (kbd->kb_type == KB_84) {
811 case 0x37: /* *(numpad)/print screen */
812 if (state->ks_flags & SHIFTS)
813 keycode = 0x5c; /* print screen */
815 case 0x45: /* num lock/pause */
816 if (state->ks_flags & CTLS)
817 keycode = 0x68; /* pause */
819 case 0x46: /* scroll lock/break */
820 if (state->ks_flags & CTLS)
821 keycode = 0x6c; /* break */
824 } else if (kbd->kb_type == KB_101) {
826 case 0x5c: /* print screen */
827 if (state->ks_flags & ALTS)
828 keycode = 0x54; /* sysrq */
830 case 0x68: /* pause/break */
831 if (state->ks_flags & CTLS)
832 keycode = 0x6c; /* break */
837 /* return the key code in the K_CODE mode */
838 if (state->ks_mode == K_CODE)
839 return (keycode | (scancode & 0x80));
841 /* compose a character code */
842 if (state->ks_flags & COMPOSE) {
843 switch (keycode | (scancode & 0x80)) {
844 /* key pressed, process it */
845 case 0x47: case 0x48: case 0x49: /* keypad 7,8,9 */
846 state->ks_composed_char *= 10;
847 state->ks_composed_char += keycode - 0x40;
848 if (state->ks_composed_char > UCHAR_MAX)
851 case 0x4B: case 0x4C: case 0x4D: /* keypad 4,5,6 */
852 state->ks_composed_char *= 10;
853 state->ks_composed_char += keycode - 0x47;
854 if (state->ks_composed_char > UCHAR_MAX)
857 case 0x4F: case 0x50: case 0x51: /* keypad 1,2,3 */
858 state->ks_composed_char *= 10;
859 state->ks_composed_char += keycode - 0x4E;
860 if (state->ks_composed_char > UCHAR_MAX)
863 case 0x52: /* keypad 0 */
864 state->ks_composed_char *= 10;
865 if (state->ks_composed_char > UCHAR_MAX)
869 /* key released, no interest here */
870 case 0xC7: case 0xC8: case 0xC9: /* keypad 7,8,9 */
871 case 0xCB: case 0xCC: case 0xCD: /* keypad 4,5,6 */
872 case 0xCF: case 0xD0: case 0xD1: /* keypad 1,2,3 */
873 case 0xD2: /* keypad 0 */
876 case 0x38: /* left alt key */
880 if (state->ks_composed_char > 0) {
881 state->ks_flags &= ~COMPOSE;
882 state->ks_composed_char = 0;
889 /* keycode to key action */
890 action = genkbd_keyaction(kbd, keycode, scancode & 0x80,
891 &state->ks_state, &state->ks_accents);
898 /* check if char is waiting */
900 atkbd_check_char(keyboard_t *kbd)
902 atkbd_state_t *state;
904 if (!KBD_IS_ACTIVE(kbd))
906 state = (atkbd_state_t *)kbd->kb_data;
907 if (!(state->ks_flags & COMPOSE) && (state->ks_composed_char > 0))
909 return kbdc_data_ready(state->kbdc);
912 /* some useful control functions */
914 atkbd_ioctl(keyboard_t *kbd, u_long cmd, caddr_t arg)
916 /* translate LED_XXX bits into the device specific bits */
917 static u_char ledmap[8] = {
918 0, 4, 2, 6, 1, 5, 3, 7,
920 atkbd_state_t *state = kbd->kb_data;
924 #if defined(COMPAT_FREEBSD6) || defined(COMPAT_FREEBSD5) || \
925 defined(COMPAT_FREEBSD4) || defined(COMPAT_43)
931 case KDGKBMODE: /* get keyboard mode */
932 *(int *)arg = state->ks_mode;
934 #if defined(COMPAT_FREEBSD6) || defined(COMPAT_FREEBSD5) || \
935 defined(COMPAT_FREEBSD4) || defined(COMPAT_43)
937 ival = IOCPARM_IVAL(arg);
938 arg = (caddr_t)&ival;
941 case KDSKBMODE: /* set keyboard mode */
942 switch (*(int *)arg) {
944 if (state->ks_mode != K_XLATE) {
945 /* make lock key state and LED state match */
946 state->ks_state &= ~LOCK_MASK;
947 state->ks_state |= KBD_LED_VAL(kbd);
952 if (state->ks_mode != *(int *)arg) {
953 atkbd_clear_state(kbd);
954 state->ks_mode = *(int *)arg;
963 case KDGETLED: /* get keyboard LED */
964 *(int *)arg = KBD_LED_VAL(kbd);
966 #if defined(COMPAT_FREEBSD6) || defined(COMPAT_FREEBSD5) || \
967 defined(COMPAT_FREEBSD4) || defined(COMPAT_43)
969 ival = IOCPARM_IVAL(arg);
970 arg = (caddr_t)&ival;
973 case KDSETLED: /* set keyboard LED */
974 /* NOTE: lock key state in ks_state won't be changed */
975 if (*(int *)arg & ~LOCK_MASK) {
980 /* replace CAPS LED with ALTGR LED for ALTGR keyboards */
981 if (state->ks_mode == K_XLATE &&
982 kbd->kb_keymap->n_keys > ALTGR_OFFSET) {
988 if (KBD_HAS_DEVICE(kbd)) {
989 error = write_kbd(state->kbdc, KBDC_SET_LEDS,
990 ledmap[i & LED_MASK]);
997 /* push LED states to evdev */
998 if (state->ks_evdev != NULL &&
999 evdev_rcpt_mask & EVDEV_RCPT_HW_KBD)
1000 evdev_push_leds(state->ks_evdev, *(int *)arg);
1002 KBD_LED_VAL(kbd) = *(int *)arg;
1005 case KDGKBSTATE: /* get lock key state */
1006 *(int *)arg = state->ks_state & LOCK_MASK;
1008 #if defined(COMPAT_FREEBSD6) || defined(COMPAT_FREEBSD5) || \
1009 defined(COMPAT_FREEBSD4) || defined(COMPAT_43)
1011 ival = IOCPARM_IVAL(arg);
1012 arg = (caddr_t)&ival;
1015 case KDSKBSTATE: /* set lock key state */
1016 if (*(int *)arg & ~LOCK_MASK) {
1020 state->ks_state &= ~LOCK_MASK;
1021 state->ks_state |= *(int *)arg;
1023 /* set LEDs and quit */
1024 return atkbd_ioctl(kbd, KDSETLED, arg);
1026 case KDSETREPEAT: /* set keyboard repeat rate (new interface) */
1028 if (!KBD_HAS_DEVICE(kbd))
1030 i = typematic(((int *)arg)[0], ((int *)arg)[1]);
1031 error = write_kbd(state->kbdc, KBDC_SET_TYPEMATIC, i);
1033 kbd->kb_delay1 = typematic_delay(i);
1034 kbd->kb_delay2 = typematic_rate(i);
1035 #ifdef EVDEV_SUPPORT
1036 if (state->ks_evdev != NULL &&
1037 evdev_rcpt_mask & EVDEV_RCPT_HW_KBD)
1038 evdev_push_repeats(state->ks_evdev, kbd);
1043 #if defined(COMPAT_FREEBSD6) || defined(COMPAT_FREEBSD5) || \
1044 defined(COMPAT_FREEBSD4) || defined(COMPAT_43)
1046 ival = IOCPARM_IVAL(arg);
1047 arg = (caddr_t)&ival;
1050 case KDSETRAD: /* set keyboard repeat rate (old interface) */
1052 if (!KBD_HAS_DEVICE(kbd))
1054 error = write_kbd(state->kbdc, KBDC_SET_TYPEMATIC, *(int *)arg);
1056 kbd->kb_delay1 = typematic_delay(*(int *)arg);
1057 kbd->kb_delay2 = typematic_rate(*(int *)arg);
1058 #ifdef EVDEV_SUPPORT
1059 if (state->ks_evdev != NULL &&
1060 evdev_rcpt_mask & EVDEV_RCPT_HW_KBD)
1061 evdev_push_repeats(state->ks_evdev, kbd);
1066 case PIO_KEYMAP: /* set keyboard translation table */
1067 case OPIO_KEYMAP: /* set keyboard translation table (compat) */
1068 case PIO_KEYMAPENT: /* set keyboard translation table entry */
1069 case PIO_DEADKEYMAP: /* set accent key translation table */
1070 state->ks_accents = 0;
1074 return genkbd_commonioctl(kbd, cmd, arg);
1081 /* lock the access to the keyboard */
1083 atkbd_lock(keyboard_t *kbd, int lock)
1085 return kbdc_lock(((atkbd_state_t *)kbd->kb_data)->kbdc, lock);
1088 /* clear the internal state of the keyboard */
1090 atkbd_clear_state(keyboard_t *kbd)
1092 atkbd_state_t *state;
1094 state = (atkbd_state_t *)kbd->kb_data;
1095 state->ks_flags = 0;
1096 state->ks_polling = 0;
1097 state->ks_state &= LOCK_MASK; /* preserve locking key state */
1098 state->ks_accents = 0;
1099 state->ks_composed_char = 0;
1101 state->ks_prefix = 0; /* XXX */
1105 /* save the internal state */
1107 atkbd_get_state(keyboard_t *kbd, void *buf, size_t len)
1110 return sizeof(atkbd_state_t);
1111 if (len < sizeof(atkbd_state_t))
1113 bcopy(kbd->kb_data, buf, sizeof(atkbd_state_t));
1117 /* set the internal state */
1119 atkbd_set_state(keyboard_t *kbd, void *buf, size_t len)
1121 if (len < sizeof(atkbd_state_t))
1123 if (((atkbd_state_t *)kbd->kb_data)->kbdc
1124 != ((atkbd_state_t *)buf)->kbdc)
1126 bcopy(buf, kbd->kb_data, sizeof(atkbd_state_t));
1131 atkbd_poll(keyboard_t *kbd, int on)
1133 atkbd_state_t *state;
1136 state = (atkbd_state_t *)kbd->kb_data;
1139 ++state->ks_polling;
1141 --state->ks_polling;
1147 atkbd_reset(KBDC kbdc, int flags, int c)
1149 /* reset keyboard hardware */
1150 if (!(flags & KB_CONF_NO_RESET) && !reset_kbd(kbdc)) {
1153 * Keyboard reset may fail either because the keyboard
1154 * doen't exist, or because the keyboard doesn't pass
1155 * the self-test, or the keyboard controller on the
1156 * motherboard and the keyboard somehow fail to shake hands.
1157 * It is just possible, particularly in the last case,
1158 * that the keyboard controller may be left in a hung state.
1159 * test_controller() and test_kbd_port() appear to bring
1160 * the keyboard controller back (I don't know why and how,
1163 empty_both_buffers(kbdc, 10);
1164 test_controller(kbdc);
1165 test_kbd_port(kbdc);
1167 * We could disable the keyboard port and interrupt... but,
1168 * the keyboard may still exist (see above).
1170 set_controller_command_byte(kbdc,
1171 ALLOW_DISABLE_KBD(kbdc) ? 0xff : KBD_KBD_CONTROL_BITS, c);
1173 printf("atkbd: failed to reset the keyboard.\n");
1179 #ifdef EVDEV_SUPPORT
1181 atkbd_ev_event(struct evdev_dev *evdev, uint16_t type, uint16_t code,
1184 keyboard_t *kbd = evdev_get_softc(evdev);
1186 if (evdev_rcpt_mask & EVDEV_RCPT_HW_KBD &&
1187 (type == EV_LED || type == EV_REP)) {
1189 kbd_ev_event(kbd, type, code, value);
1195 /* local functions */
1198 set_typematic(keyboard_t *kbd)
1201 atkbd_state_t *state = kbd->kb_data;
1203 val = typematic(DEFAULT_DELAY, DEFAULT_RATE);
1204 error = write_kbd(state->kbdc, KBDC_SET_TYPEMATIC, val);
1206 kbd->kb_delay1 = typematic_delay(val);
1207 kbd->kb_delay2 = typematic_rate(val);
1214 setup_kbd_port(KBDC kbdc, int port, int intr)
1216 if (!set_controller_command_byte(kbdc,
1217 KBD_KBD_CONTROL_BITS,
1218 ((port) ? KBD_ENABLE_KBD_PORT : KBD_DISABLE_KBD_PORT)
1219 | ((intr) ? KBD_ENABLE_KBD_INT : KBD_DISABLE_KBD_INT)))
1225 get_kbd_echo(KBDC kbdc)
1227 /* enable the keyboard port, but disable the keyboard intr. */
1228 if (setup_kbd_port(kbdc, TRUE, FALSE))
1229 /* CONTROLLER ERROR: there is very little we can do... */
1232 /* see if something is present */
1233 write_kbd_command(kbdc, KBDC_ECHO);
1234 if (read_kbd_data(kbdc) != KBD_ECHO) {
1235 empty_both_buffers(kbdc, 10);
1236 test_controller(kbdc);
1237 test_kbd_port(kbdc);
1241 /* enable the keyboard port and intr. */
1242 if (setup_kbd_port(kbdc, TRUE, TRUE)) {
1245 * This is serious; the keyboard intr is left disabled!
1254 probe_keyboard(KBDC kbdc, int flags)
1257 * Don't try to print anything in this function. The low-level
1258 * console may not have been initialized yet...
1264 if (!kbdc_lock(kbdc, TRUE)) {
1269 /* temporarily block data transmission from the keyboard */
1270 write_controller_command(kbdc, KBDC_DISABLE_KBD_PORT);
1272 /* flush any noise in the buffer */
1273 empty_both_buffers(kbdc, 100);
1275 /* save the current keyboard controller command byte */
1276 m = kbdc_get_device_mask(kbdc) & ~KBD_KBD_CONTROL_BITS;
1277 c = get_controller_command_byte(kbdc);
1279 /* CONTROLLER ERROR */
1280 kbdc_set_device_mask(kbdc, m);
1281 kbdc_lock(kbdc, FALSE);
1286 * The keyboard may have been screwed up by the boot block.
1287 * We may just be able to recover from error by testing the controller
1288 * and the keyboard port. The controller command byte needs to be
1289 * saved before this recovery operation, as some controllers seem
1290 * to set the command byte to particular values.
1292 test_controller(kbdc);
1293 if (!(flags & KB_CONF_NO_PROBE_TEST))
1294 test_kbd_port(kbdc);
1296 err = get_kbd_echo(kbdc);
1299 * Even if the keyboard doesn't seem to be present (err != 0),
1300 * we shall enable the keyboard port and interrupt so that
1301 * the driver will be operable when the keyboard is attached
1302 * to the system later. It is NOT recommended to hot-plug
1303 * the AT keyboard, but many people do so...
1305 kbdc_set_device_mask(kbdc, m | KBD_KBD_CONTROL_BITS);
1306 setup_kbd_port(kbdc, TRUE, TRUE);
1309 kbdc_set_device_mask(kbdc, m | KBD_KBD_CONTROL_BITS);
1311 /* try to restore the command byte as before */
1312 set_controller_command_byte(kbdc,
1313 ALLOW_DISABLE_KBD(kbdc) ? 0xff : KBD_KBD_CONTROL_BITS, c);
1314 kbdc_set_device_mask(kbdc, m);
1318 kbdc_lock(kbdc, FALSE);
1319 return (HAS_QUIRK(kbdc, KBDC_QUIRK_IGNORE_PROBE_RESULT) ? 0 : err);
1323 init_keyboard(KBDC kbdc, int *type, int flags)
1329 if (!kbdc_lock(kbdc, TRUE)) {
1334 /* temporarily block data transmission from the keyboard */
1335 write_controller_command(kbdc, KBDC_DISABLE_KBD_PORT);
1337 /* save the current controller command byte */
1338 empty_both_buffers(kbdc, 200);
1339 c = get_controller_command_byte(kbdc);
1341 /* CONTROLLER ERROR */
1342 kbdc_lock(kbdc, FALSE);
1343 printf("atkbd: unable to get the current command byte value.\n");
1347 printf("atkbd: the current kbd controller command byte %04x\n",
1350 /* override the keyboard lock switch */
1351 c |= KBD_OVERRIDE_KBD_LOCK;
1354 /* enable the keyboard port, but disable the keyboard intr. */
1355 if (setup_kbd_port(kbdc, TRUE, FALSE)) {
1356 /* CONTROLLER ERROR: there is very little we can do... */
1357 printf("atkbd: unable to set the command byte.\n");
1358 kbdc_lock(kbdc, FALSE);
1362 if (HAS_QUIRK(kbdc, KBDC_QUIRK_RESET_AFTER_PROBE) &&
1363 atkbd_reset(kbdc, flags, c)) {
1364 kbdc_lock(kbdc, FALSE);
1369 * Check if we have an XT keyboard before we attempt to reset it.
1370 * The procedure assumes that the keyboard and the controller have
1371 * been set up properly by BIOS and have not been messed up
1372 * during the boot process.
1375 if (flags & KB_CONF_ALT_SCANCODESET)
1376 /* the user says there is a XT keyboard */
1378 #ifdef KBD_DETECT_XT_KEYBOARD
1379 else if ((c & KBD_TRANSLATION) == 0) {
1380 /* SET_SCANCODE_SET is not always supported; ignore error */
1381 if (send_kbd_command_and_data(kbdc, KBDC_SET_SCANCODE_SET, 0)
1383 codeset = read_kbd_data(kbdc);
1386 printf("atkbd: scancode set %d\n", codeset);
1387 #endif /* KBD_DETECT_XT_KEYBOARD */
1390 id = get_kbd_id(kbdc);
1392 case 0x41ab: /* 101/102/... Enhanced */
1393 case 0x83ab: /* ditto */
1394 case 0x54ab: /* SpaceSaver */
1395 case 0x84ab: /* ditto */
1397 case 0x90ab: /* 'G' */
1398 case 0x91ab: /* 'P' */
1399 case 0x92ab: /* 'A' */
1403 case -1: /* AT 84 keyboard doesn't return ID */
1410 printf("atkbd: keyboard ID 0x%x (%d)\n", id, *type);
1412 if (!HAS_QUIRK(kbdc, KBDC_QUIRK_RESET_AFTER_PROBE) &&
1413 atkbd_reset(kbdc, flags, c)) {
1414 kbdc_lock(kbdc, FALSE);
1419 * Allow us to set the XT_KEYBD flag so that keyboards
1420 * such as those on the IBM ThinkPad laptop computers can be used
1421 * with the standard console driver.
1424 if (send_kbd_command_and_data(kbdc,
1425 KBDC_SET_SCANCODE_SET, codeset) == KBD_ACK) {
1426 /* XT kbd doesn't need scan code translation */
1427 c &= ~KBD_TRANSLATION;
1431 * The XT kbd isn't usable unless the proper scan
1432 * code set is selected.
1434 set_controller_command_byte(kbdc, ALLOW_DISABLE_KBD(kbdc)
1435 ? 0xff : KBD_KBD_CONTROL_BITS, c);
1436 kbdc_lock(kbdc, FALSE);
1437 printf("atkbd: unable to set the XT keyboard mode.\n");
1443 * Some keyboards require a SETLEDS command to be sent after
1444 * the reset command before they will send keystrokes to us
1446 if (HAS_QUIRK(kbdc, KBDC_QUIRK_SETLEDS_ON_INIT) &&
1447 send_kbd_command_and_data(kbdc, KBDC_SET_LEDS, 0) != KBD_ACK) {
1448 printf("atkbd: setleds failed\n");
1450 if (!ALLOW_DISABLE_KBD(kbdc))
1451 send_kbd_command(kbdc, KBDC_ENABLE_KBD);
1453 /* enable the keyboard port and intr. */
1454 if (!set_controller_command_byte(kbdc,
1455 KBD_KBD_CONTROL_BITS | KBD_TRANSLATION | KBD_OVERRIDE_KBD_LOCK,
1456 (c & (KBD_TRANSLATION | KBD_OVERRIDE_KBD_LOCK))
1457 | KBD_ENABLE_KBD_PORT | KBD_ENABLE_KBD_INT)) {
1460 * This is serious; we are left with the disabled
1463 set_controller_command_byte(kbdc, ALLOW_DISABLE_KBD(kbdc)
1464 ? 0xff : (KBD_KBD_CONTROL_BITS | KBD_TRANSLATION |
1465 KBD_OVERRIDE_KBD_LOCK), c);
1466 kbdc_lock(kbdc, FALSE);
1467 printf("atkbd: unable to enable the keyboard port and intr.\n");
1471 kbdc_lock(kbdc, FALSE);
1476 write_kbd(KBDC kbdc, int command, int data)
1480 /* prevent the timeout routine from polling the keyboard */
1481 if (!kbdc_lock(kbdc, TRUE))
1484 /* disable the keyboard and mouse interrupt */
1487 c = get_controller_command_byte(kbdc);
1489 || !set_controller_command_byte(kbdc,
1490 kbdc_get_device_mask(kbdc),
1491 KBD_DISABLE_KBD_PORT | KBD_DISABLE_KBD_INT
1492 | KBD_DISABLE_AUX_PORT | KBD_DISABLE_AUX_INT)) {
1493 /* CONTROLLER ERROR */
1494 kbdc_lock(kbdc, FALSE);
1499 * Now that the keyboard controller is told not to generate
1500 * the keyboard and mouse interrupts, call `splx()' to allow
1501 * the other tty interrupts. The clock interrupt may also occur,
1502 * but the timeout routine (`scrn_timer()') will be blocked
1503 * by the lock flag set via `kbdc_lock()'
1507 if (send_kbd_command_and_data(kbdc, command, data) != KBD_ACK)
1508 send_kbd_command(kbdc, KBDC_ENABLE_KBD);
1510 /* restore the interrupts */
1511 if (!set_controller_command_byte(kbdc, kbdc_get_device_mask(kbdc),
1512 c & (KBD_KBD_CONTROL_BITS | KBD_AUX_CONTROL_BITS))) {
1513 /* CONTROLLER ERROR */
1518 kbdc_lock(kbdc, FALSE);
1524 get_kbd_id(KBDC kbdc)
1528 empty_both_buffers(kbdc, 10);
1530 if (send_kbd_command(kbdc, KBDC_SEND_DEV_ID) != KBD_ACK)
1533 DELAY(10000); /* 10 msec delay */
1534 id1 = read_kbd_data(kbdc);
1536 id2 = read_kbd_data(kbdc);
1538 if ((id1 == -1) || (id2 == -1)) {
1539 empty_both_buffers(kbdc, 10);
1540 test_controller(kbdc);
1541 test_kbd_port(kbdc);
1544 return ((id2 << 8) | id1);
1547 static int delays[] = { 250, 500, 750, 1000 };
1548 static int rates[] = { 34, 38, 42, 46, 50, 55, 59, 63,
1549 68, 76, 84, 92, 100, 110, 118, 126,
1550 136, 152, 168, 184, 200, 220, 236, 252,
1551 272, 304, 336, 368, 400, 440, 472, 504 };
1554 typematic_delay(int i)
1556 return delays[(i >> 5) & 3];
1560 typematic_rate(int i)
1562 return rates[i & 0x1f];
1566 typematic(int delay, int rate)
1571 for (i = nitems(delays) - 1; i > 0; --i) {
1572 if (delay >= delays[i])
1576 for (i = nitems(rates) - 1; i > 0; --i) {
1577 if (rate >= rates[i])