2 * Copyright (c) 1999 Kazutaka YOKOTA <yokota@zodiac.mech.utsunomiya-u.ac.jp>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer as
10 * the first lines of this file unmodified.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR
16 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18 * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT,
19 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 #include "opt_atkbd.h"
32 #include <sys/param.h>
33 #include <sys/systm.h>
34 #include <sys/kernel.h>
37 #include <sys/malloc.h>
39 #include <machine/bus.h>
40 #include <machine/resource.h>
43 #include <machine/md_var.h>
44 #include <machine/psl.h>
45 #include <machine/vm86.h>
46 #include <machine/pc/bios.h>
52 #include <dev/kbd/kbdreg.h>
53 #include <dev/kbd/atkbdreg.h>
54 #include <dev/kbd/atkbdcreg.h>
56 #include <isa/isareg.h>
58 static timeout_t atkbd_timeout;
61 atkbd_probe_unit(int unit, int ctlr, int irq, int flags)
63 keyboard_switch_t *sw;
67 sw = kbd_get_switch(ATKBD_DRIVER_NAME);
73 error = (*sw->probe)(unit, args, flags);
80 atkbd_attach_unit(int unit, keyboard_t **kbd, int ctlr, int irq, int flags)
82 keyboard_switch_t *sw;
86 sw = kbd_get_switch(ATKBD_DRIVER_NAME);
90 /* reset, initialize and enable the device */
94 error = (*sw->probe)(unit, args, flags);
97 error = (*sw->init)(unit, kbd, args, flags);
102 #ifdef KBD_INSTALL_CDEV
103 /* attach a virtual keyboard cdev */
104 error = kbd_attach(*kbd);
110 * This is a kludge to compensate for lost keyboard interrupts.
111 * A similar code used to be in syscons. See below. XXX
116 (*sw->diag)(*kbd, bootverbose);
121 atkbd_timeout(void *arg)
127 * The original text of the following comments are extracted
128 * from syscons.c (1.287)
130 * With release 2.1 of the Xaccel server, the keyboard is left
131 * hanging pretty often. Apparently an interrupt from the
132 * keyboard is lost, and I don't know why (yet).
133 * This ugly hack calls the low-level interrupt routine if input
134 * is ready for the keyboard and conveniently hides the problem. XXX
136 * Try removing anything stuck in the keyboard controller; whether
137 * it's a keyboard scan code or mouse data. The low-level
138 * interrupt routine doesn't read the mouse data directly,
139 * but the keyboard controller driver will, as a side effect.
142 * And here is bde's original comment about this:
144 * This is necessary to handle edge triggered interrupts - if we
145 * returned when our IRQ is high due to unserviced input, then there
146 * would be no more keyboard IRQs until the keyboard is reset by
149 * The keyboard apparently unwedges the irq in most cases.
152 kbd = (keyboard_t *)arg;
153 if ((*kbdsw[kbd->kb_index]->lock)(kbd, TRUE)) {
155 * We have seen the lock flag is not set. Let's reset
156 * the flag early, otherwise the LED update routine fails
157 * which may want the lock during the interrupt routine.
159 (*kbdsw[kbd->kb_index]->lock)(kbd, FALSE);
160 if ((*kbdsw[kbd->kb_index]->check_char)(kbd))
161 (*kbdsw[kbd->kb_index]->intr)(kbd, NULL);
164 timeout(atkbd_timeout, arg, hz/10);
169 #include <machine/limits.h>
170 #include <machine/console.h>
171 #include <machine/clock.h>
173 #define ATKBD_DEFAULT 0
175 typedef struct atkbd_state {
176 KBDC kbdc; /* keyboard controller */
177 /* XXX: don't move this field; pcvt
178 * expects `kbdc' to be the first
179 * field in this structure. */
180 int ks_mode; /* input mode (K_XLATE,K_RAW,K_CODE) */
181 int ks_flags; /* flags */
182 #define COMPOSE (1 << 0)
184 int ks_state; /* shift/lock key state */
185 int ks_accents; /* accent key index (> 0) */
186 u_int ks_composed_char; /* composed char code (> 0) */
187 u_char ks_prefix; /* AT scan code prefix */
190 /* keyboard driver declaration */
191 static int atkbd_configure(int flags);
192 static kbd_probe_t atkbd_probe;
193 static kbd_init_t atkbd_init;
194 static kbd_term_t atkbd_term;
195 static kbd_intr_t atkbd_intr;
196 static kbd_test_if_t atkbd_test_if;
197 static kbd_enable_t atkbd_enable;
198 static kbd_disable_t atkbd_disable;
199 static kbd_read_t atkbd_read;
200 static kbd_check_t atkbd_check;
201 static kbd_read_char_t atkbd_read_char;
202 static kbd_check_char_t atkbd_check_char;
203 static kbd_ioctl_t atkbd_ioctl;
204 static kbd_lock_t atkbd_lock;
205 static kbd_clear_state_t atkbd_clear_state;
206 static kbd_get_state_t atkbd_get_state;
207 static kbd_set_state_t atkbd_set_state;
208 static kbd_poll_mode_t atkbd_poll;
210 keyboard_switch_t atkbdsw = {
232 KEYBOARD_DRIVER(atkbd, atkbdsw, atkbd_configure);
234 /* local functions */
235 static int get_typematic(keyboard_t *kbd);
236 static int setup_kbd_port(KBDC kbdc, int port, int intr);
237 static int get_kbd_echo(KBDC kbdc);
238 static int probe_keyboard(KBDC kbdc, int flags);
239 static int init_keyboard(KBDC kbdc, int *type, int flags);
240 static int write_kbd(KBDC kbdc, int command, int data);
241 static int get_kbd_id(KBDC kbdc);
242 static int typematic(int delay, int rate);
243 static int typematic_delay(int delay);
244 static int typematic_rate(int rate);
246 /* local variables */
248 /* the initial key map, accent map and fkey strings */
249 #ifdef ATKBD_DFLT_KEYMAP
250 #define KBD_DFLT_KEYMAP
251 #include "atkbdmap.h"
253 #include <dev/kbd/kbdtables.h>
255 /* structures for the default keyboard */
256 static keyboard_t default_kbd;
257 static atkbd_state_t default_kbd_state;
258 static keymap_t default_keymap;
259 static accentmap_t default_accentmap;
260 static fkeytab_t default_fkeytab[NUM_FKEYS];
263 * The back door to the keyboard driver!
264 * This function is called by the console driver, via the kbdio module,
265 * to tickle keyboard drivers when the low-level console is being initialized.
266 * Almost nothing in the kernel has been initialied yet. Try to probe
267 * keyboards if possible.
268 * NOTE: because of the way the low-level conole is initialized, this routine
269 * may be called more than once!!
272 atkbd_configure(int flags)
278 /* probe the keyboard controller */
281 /* if the driver is disabled, unregister the keyboard if any */
282 if ((resource_int_value("atkbd", ATKBD_DEFAULT, "disabled", &i) == 0)
284 i = kbd_find_keyboard(ATKBD_DRIVER_NAME, ATKBD_DEFAULT);
286 kbd = kbd_get_keyboard(i);
288 kbd->kb_flags &= ~KB_REGISTERED;
293 /* XXX: a kludge to obtain the device configuration flags */
294 if (resource_int_value("atkbd", ATKBD_DEFAULT, "flags", &i) == 0)
297 /* probe the default keyboard */
301 if (atkbd_probe(ATKBD_DEFAULT, arg, flags))
303 if (atkbd_init(ATKBD_DEFAULT, &kbd, arg, flags))
306 /* return the number of found keyboards */
310 /* low-level functions */
312 /* detect a keyboard */
314 atkbd_probe(int unit, void *arg, int flags)
317 int *data = (int *)arg; /* data[0]: controller, data[1]: irq */
320 if (unit == ATKBD_DEFAULT) {
321 if (KBD_IS_PROBED(&default_kbd))
325 kbdc = atkbdc_open(data[0]);
328 if (probe_keyboard(kbdc, flags)) {
329 if (flags & KB_CONF_FAIL_IF_NO_KBD)
335 /* reset and initialize the device */
337 atkbd_init(int unit, keyboard_t **kbdp, void *arg, int flags)
340 atkbd_state_t *state;
346 int *data = (int *)arg; /* data[0]: controller, data[1]: irq */
349 if (unit == ATKBD_DEFAULT) {
350 *kbdp = kbd = &default_kbd;
351 if (KBD_IS_INITIALIZED(kbd) && KBD_IS_CONFIGURED(kbd))
353 state = &default_kbd_state;
354 keymap = &default_keymap;
355 accmap = &default_accentmap;
356 fkeymap = default_fkeytab;
358 sizeof(default_fkeytab)/sizeof(default_fkeytab[0]);
359 } else if (*kbdp == NULL) {
360 *kbdp = kbd = malloc(sizeof(*kbd), M_DEVBUF, M_NOWAIT);
363 bzero(kbd, sizeof(*kbd));
364 state = malloc(sizeof(*state), M_DEVBUF, M_NOWAIT);
365 keymap = malloc(sizeof(key_map), M_DEVBUF, M_NOWAIT);
366 accmap = malloc(sizeof(accent_map), M_DEVBUF, M_NOWAIT);
367 fkeymap = malloc(sizeof(fkey_tab), M_DEVBUF, M_NOWAIT);
368 fkeymap_size = sizeof(fkey_tab)/sizeof(fkey_tab[0]);
369 if ((state == NULL) || (keymap == NULL) || (accmap == NULL)
370 || (fkeymap == NULL)) {
372 free(state, M_DEVBUF);
374 free(keymap, M_DEVBUF);
376 free(accmap, M_DEVBUF);
378 free(fkeymap, M_DEVBUF);
382 bzero(state, sizeof(*state));
383 } else if (KBD_IS_INITIALIZED(*kbdp) && KBD_IS_CONFIGURED(*kbdp)) {
387 state = (atkbd_state_t *)kbd->kb_data;
388 bzero(state, sizeof(*state));
389 keymap = kbd->kb_keymap;
390 accmap = kbd->kb_accentmap;
391 fkeymap = kbd->kb_fkeytab;
392 fkeymap_size = kbd->kb_fkeytab_size;
395 if (!KBD_IS_PROBED(kbd)) {
396 state->kbdc = atkbdc_open(data[0]);
397 if (state->kbdc == NULL)
399 kbd_init_struct(kbd, ATKBD_DRIVER_NAME, KB_OTHER, unit, flags,
401 bcopy(&key_map, keymap, sizeof(key_map));
402 bcopy(&accent_map, accmap, sizeof(accent_map));
403 bcopy(fkey_tab, fkeymap,
404 imin(fkeymap_size*sizeof(fkeymap[0]), sizeof(fkey_tab)));
405 kbd_set_maps(kbd, keymap, accmap, fkeymap, fkeymap_size);
406 kbd->kb_data = (void *)state;
408 if (probe_keyboard(state->kbdc, flags)) { /* shouldn't happen */
409 if (flags & KB_CONF_FAIL_IF_NO_KBD)
412 KBD_FOUND_DEVICE(kbd);
414 atkbd_clear_state(kbd);
415 state->ks_mode = K_XLATE;
417 * FIXME: set the initial value for lock keys in ks_state
418 * according to the BIOS data?
422 if (!KBD_IS_INITIALIZED(kbd) && !(flags & KB_CONF_PROBE_ONLY)) {
423 kbd->kb_config = flags & ~KB_CONF_PROBE_ONLY;
424 if (KBD_HAS_DEVICE(kbd)
425 && init_keyboard(state->kbdc, &kbd->kb_type, kbd->kb_config)
426 && (kbd->kb_config & KB_CONF_FAIL_IF_NO_KBD))
428 atkbd_ioctl(kbd, KDSETLED, (caddr_t)&state->ks_state);
430 delay[0] = kbd->kb_delay1;
431 delay[1] = kbd->kb_delay2;
432 atkbd_ioctl(kbd, KDSETREPEAT, (caddr_t)delay);
435 if (!KBD_IS_CONFIGURED(kbd)) {
436 if (kbd_register(kbd) < 0)
438 KBD_CONFIG_DONE(kbd);
444 /* finish using this keyboard */
446 atkbd_term(keyboard_t *kbd)
452 /* keyboard interrupt routine */
454 atkbd_intr(keyboard_t *kbd, void *arg)
456 atkbd_state_t *state;
460 if (KBD_IS_ACTIVE(kbd) && KBD_IS_BUSY(kbd)) {
461 /* let the callback function to process the input */
462 (*kbd->kb_callback.kc_func)(kbd, KBDIO_KEYINPUT,
463 kbd->kb_callback.kc_arg);
465 /* read and discard the input; no one is waiting for input */
467 c = atkbd_read_char(kbd, FALSE);
468 } while (c != NOKEY);
470 if (!KBD_HAS_DEVICE(kbd)) {
472 * The keyboard was not detected before;
473 * it must have been reconnected!
475 state = (atkbd_state_t *)kbd->kb_data;
476 init_keyboard(state->kbdc, &kbd->kb_type,
478 atkbd_ioctl(kbd, KDSETLED, (caddr_t)&state->ks_state);
480 delay[0] = kbd->kb_delay1;
481 delay[1] = kbd->kb_delay2;
482 atkbd_ioctl(kbd, KDSETREPEAT, (caddr_t)delay);
483 KBD_FOUND_DEVICE(kbd);
489 /* test the interface to the device */
491 atkbd_test_if(keyboard_t *kbd)
497 empty_both_buffers(((atkbd_state_t *)kbd->kb_data)->kbdc, 10);
499 if (!test_controller(((atkbd_state_t *)kbd->kb_data)->kbdc))
501 else if (test_kbd_port(((atkbd_state_t *)kbd->kb_data)->kbdc) != 0)
509 * Enable the access to the device; until this function is called,
510 * the client cannot read from the keyboard.
513 atkbd_enable(keyboard_t *kbd)
523 /* disallow the access to the device */
525 atkbd_disable(keyboard_t *kbd)
535 /* read one byte from the keyboard if it's allowed */
537 atkbd_read(keyboard_t *kbd, int wait)
542 c = read_kbd_data(((atkbd_state_t *)kbd->kb_data)->kbdc);
544 c = read_kbd_data_no_wait(((atkbd_state_t *)kbd->kb_data)->kbdc);
547 return (KBD_IS_ACTIVE(kbd) ? c : -1);
550 /* check if data is waiting */
552 atkbd_check(keyboard_t *kbd)
554 if (!KBD_IS_ACTIVE(kbd))
556 return kbdc_data_ready(((atkbd_state_t *)kbd->kb_data)->kbdc);
559 /* read char from the keyboard */
561 atkbd_read_char(keyboard_t *kbd, int wait)
563 atkbd_state_t *state;
568 state = (atkbd_state_t *)kbd->kb_data;
570 /* do we have a composed char to return? */
571 if (!(state->ks_flags & COMPOSE) && (state->ks_composed_char > 0)) {
572 action = state->ks_composed_char;
573 state->ks_composed_char = 0;
574 if (action > UCHAR_MAX)
579 /* see if there is something in the keyboard port */
582 scancode = read_kbd_data(state->kbdc);
583 } while (scancode == -1);
585 scancode = read_kbd_data_no_wait(state->kbdc);
591 #if KBDIO_DEBUG >= 10
592 printf("atkbd_read_char(): scancode:0x%x\n", scancode);
595 /* return the byte as is for the K_RAW mode */
596 if (state->ks_mode == K_RAW)
599 /* translate the scan code into a keycode */
600 keycode = scancode & 0x7F;
601 switch (state->ks_prefix) {
602 case 0x00: /* normal scancode */
604 case 0xB8: /* left alt (compose key) released */
605 if (state->ks_flags & COMPOSE) {
606 state->ks_flags &= ~COMPOSE;
607 if (state->ks_composed_char > UCHAR_MAX)
608 state->ks_composed_char = 0;
611 case 0x38: /* left alt (compose key) pressed */
612 if (!(state->ks_flags & COMPOSE)) {
613 state->ks_flags |= COMPOSE;
614 state->ks_composed_char = 0;
619 state->ks_prefix = scancode;
623 case 0xE0: /* 0xE0 prefix */
624 state->ks_prefix = 0;
626 case 0x1C: /* right enter key */
629 case 0x1D: /* right ctrl key */
632 case 0x35: /* keypad divide key */
635 case 0x37: /* print scrn key */
638 case 0x38: /* right alt key (alt gr) */
641 case 0x46: /* ctrl-pause/break on AT 101 (see below) */
644 case 0x47: /* grey home key */
647 case 0x48: /* grey up arrow key */
650 case 0x49: /* grey page up key */
653 case 0x4B: /* grey left arrow key */
656 case 0x4D: /* grey right arrow key */
659 case 0x4F: /* grey end key */
662 case 0x50: /* grey down arrow key */
665 case 0x51: /* grey page down key */
668 case 0x52: /* grey insert key */
671 case 0x53: /* grey delete key */
674 /* the following 3 are only used on the MS "Natural" keyboard */
675 case 0x5b: /* left Window key */
678 case 0x5c: /* right Window key */
681 case 0x5d: /* menu key */
684 default: /* ignore everything else */
688 case 0xE1: /* 0xE1 prefix */
690 * The pause/break key on the 101 keyboard produces:
692 * Ctrl-pause/break produces:
693 * E0-46 E0-C6 (See above.)
695 state->ks_prefix = 0;
697 state->ks_prefix = 0x1D;
700 case 0x1D: /* pause / break */
701 state->ks_prefix = 0;
708 if (kbd->kb_type == KB_84) {
710 case 0x37: /* *(numpad)/print screen */
711 if (state->ks_flags & SHIFTS)
712 keycode = 0x5c; /* print screen */
714 case 0x45: /* num lock/pause */
715 if (state->ks_flags & CTLS)
716 keycode = 0x68; /* pause */
718 case 0x46: /* scroll lock/break */
719 if (state->ks_flags & CTLS)
720 keycode = 0x6c; /* break */
723 } else if (kbd->kb_type == KB_101) {
725 case 0x5c: /* print screen */
726 if (state->ks_flags & ALTS)
727 keycode = 0x54; /* sysrq */
729 case 0x68: /* pause/break */
730 if (state->ks_flags & CTLS)
731 keycode = 0x6c; /* break */
736 /* return the key code in the K_CODE mode */
737 if (state->ks_mode == K_CODE)
738 return (keycode | (scancode & 0x80));
740 /* compose a character code */
741 if (state->ks_flags & COMPOSE) {
742 switch (keycode | (scancode & 0x80)) {
743 /* key pressed, process it */
744 case 0x47: case 0x48: case 0x49: /* keypad 7,8,9 */
745 state->ks_composed_char *= 10;
746 state->ks_composed_char += keycode - 0x40;
747 if (state->ks_composed_char > UCHAR_MAX)
750 case 0x4B: case 0x4C: case 0x4D: /* keypad 4,5,6 */
751 state->ks_composed_char *= 10;
752 state->ks_composed_char += keycode - 0x47;
753 if (state->ks_composed_char > UCHAR_MAX)
756 case 0x4F: case 0x50: case 0x51: /* keypad 1,2,3 */
757 state->ks_composed_char *= 10;
758 state->ks_composed_char += keycode - 0x4E;
759 if (state->ks_composed_char > UCHAR_MAX)
762 case 0x52: /* keypad 0 */
763 state->ks_composed_char *= 10;
764 if (state->ks_composed_char > UCHAR_MAX)
768 /* key released, no interest here */
769 case 0xC7: case 0xC8: case 0xC9: /* keypad 7,8,9 */
770 case 0xCB: case 0xCC: case 0xCD: /* keypad 4,5,6 */
771 case 0xCF: case 0xD0: case 0xD1: /* keypad 1,2,3 */
772 case 0xD2: /* keypad 0 */
775 case 0x38: /* left alt key */
779 if (state->ks_composed_char > 0) {
780 state->ks_flags &= ~COMPOSE;
781 state->ks_composed_char = 0;
788 /* keycode to key action */
789 action = genkbd_keyaction(kbd, keycode, scancode & 0x80,
790 &state->ks_state, &state->ks_accents);
797 /* check if char is waiting */
799 atkbd_check_char(keyboard_t *kbd)
801 atkbd_state_t *state;
803 if (!KBD_IS_ACTIVE(kbd))
805 state = (atkbd_state_t *)kbd->kb_data;
806 if (!(state->ks_flags & COMPOSE) && (state->ks_composed_char > 0))
808 return kbdc_data_ready(state->kbdc);
811 /* some useful control functions */
813 atkbd_ioctl(keyboard_t *kbd, u_long cmd, caddr_t arg)
815 /* trasnlate LED_XXX bits into the device specific bits */
816 static u_char ledmap[8] = {
817 0, 4, 2, 6, 1, 5, 3, 7,
819 atkbd_state_t *state = kbd->kb_data;
827 case KDGKBMODE: /* get keyboard mode */
828 *(int *)arg = state->ks_mode;
830 case KDSKBMODE: /* set keyboard mode */
831 switch (*(int *)arg) {
833 if (state->ks_mode != K_XLATE) {
834 /* make lock key state and LED state match */
835 state->ks_state &= ~LOCK_MASK;
836 state->ks_state |= KBD_LED_VAL(kbd);
841 if (state->ks_mode != *(int *)arg) {
842 atkbd_clear_state(kbd);
843 state->ks_mode = *(int *)arg;
852 case KDGETLED: /* get keyboard LED */
853 *(int *)arg = KBD_LED_VAL(kbd);
855 case KDSETLED: /* set keyboard LED */
856 /* NOTE: lock key state in ks_state won't be changed */
857 if (*(int *)arg & ~LOCK_MASK) {
862 /* replace CAPS LED with ALTGR LED for ALTGR keyboards */
863 if (kbd->kb_keymap->n_keys > ALTGR_OFFSET) {
869 if (KBD_HAS_DEVICE(kbd)) {
870 error = write_kbd(state->kbdc, KBDC_SET_LEDS,
871 ledmap[i & LED_MASK]);
877 KBD_LED_VAL(kbd) = *(int *)arg;
880 case KDGKBSTATE: /* get lock key state */
881 *(int *)arg = state->ks_state & LOCK_MASK;
883 case KDSKBSTATE: /* set lock key state */
884 if (*(int *)arg & ~LOCK_MASK) {
888 state->ks_state &= ~LOCK_MASK;
889 state->ks_state |= *(int *)arg;
891 /* set LEDs and quit */
892 return atkbd_ioctl(kbd, KDSETLED, arg);
894 case KDSETREPEAT: /* set keyboard repeat rate (new interface) */
896 if (!KBD_HAS_DEVICE(kbd))
898 i = typematic(((int *)arg)[0], ((int *)arg)[1]);
899 error = write_kbd(state->kbdc, KBDC_SET_TYPEMATIC, i);
901 kbd->kb_delay1 = typematic_delay(i);
902 kbd->kb_delay2 = typematic_rate(i);
906 case KDSETRAD: /* set keyboard repeat rate (old interface) */
908 if (!KBD_HAS_DEVICE(kbd))
910 error = write_kbd(state->kbdc, KBDC_SET_TYPEMATIC, *(int *)arg);
912 kbd->kb_delay1 = typematic_delay(*(int *)arg);
913 kbd->kb_delay2 = typematic_rate(*(int *)arg);
917 case PIO_KEYMAP: /* set keyboard translation table */
918 case PIO_KEYMAPENT: /* set keyboard translation table entry */
919 case PIO_DEADKEYMAP: /* set accent key translation table */
920 state->ks_accents = 0;
924 return genkbd_commonioctl(kbd, cmd, arg);
931 /* lock the access to the keyboard */
933 atkbd_lock(keyboard_t *kbd, int lock)
935 return kbdc_lock(((atkbd_state_t *)kbd->kb_data)->kbdc, lock);
938 /* clear the internal state of the keyboard */
940 atkbd_clear_state(keyboard_t *kbd)
942 atkbd_state_t *state;
944 state = (atkbd_state_t *)kbd->kb_data;
946 state->ks_polling = 0;
947 state->ks_state &= LOCK_MASK; /* preserve locking key state */
948 state->ks_accents = 0;
949 state->ks_composed_char = 0;
951 state->ks_prefix = 0; /* XXX */
955 /* save the internal state */
957 atkbd_get_state(keyboard_t *kbd, void *buf, size_t len)
960 return sizeof(atkbd_state_t);
961 if (len < sizeof(atkbd_state_t))
963 bcopy(kbd->kb_data, buf, sizeof(atkbd_state_t));
967 /* set the internal state */
969 atkbd_set_state(keyboard_t *kbd, void *buf, size_t len)
971 if (len < sizeof(atkbd_state_t))
973 if (((atkbd_state_t *)kbd->kb_data)->kbdc
974 != ((atkbd_state_t *)buf)->kbdc)
976 bcopy(buf, kbd->kb_data, sizeof(atkbd_state_t));
981 atkbd_poll(keyboard_t *kbd, int on)
983 atkbd_state_t *state;
986 state = (atkbd_state_t *)kbd->kb_data;
996 /* local functions */
999 get_typematic(keyboard_t *kbd)
1003 * Only some systems allow us to retrieve the keyboard repeat
1004 * rate previously set via the BIOS...
1006 struct vm86frame vmf;
1009 bzero(&vmf, sizeof(vmf));
1010 vmf.vmf_ax = 0xc000;
1011 vm86_intcall(0x15, &vmf);
1012 if ((vmf.vmf_eflags & PSL_C) || vmf.vmf_ah)
1014 p = BIOS_PADDRTOVADDR(((u_int32_t)vmf.vmf_es << 4) + vmf.vmf_bx);
1015 if ((readb(p + 6) & 0x40) == 0) /* int 16, function 0x09 supported? */
1017 vmf.vmf_ax = 0x0900;
1018 vm86_intcall(0x16, &vmf);
1019 if ((vmf.vmf_al & 0x08) == 0) /* int 16, function 0x0306 supported? */
1021 vmf.vmf_ax = 0x0306;
1022 vm86_intcall(0x16, &vmf);
1023 kbd->kb_delay1 = typematic_delay(vmf.vmf_bh << 5);
1024 kbd->kb_delay2 = typematic_rate(vmf.vmf_bl);
1028 #endif /* __i386__ */
1032 setup_kbd_port(KBDC kbdc, int port, int intr)
1034 if (!set_controller_command_byte(kbdc,
1035 KBD_KBD_CONTROL_BITS,
1036 ((port) ? KBD_ENABLE_KBD_PORT : KBD_DISABLE_KBD_PORT)
1037 | ((intr) ? KBD_ENABLE_KBD_INT : KBD_DISABLE_KBD_INT)))
1043 get_kbd_echo(KBDC kbdc)
1045 /* enable the keyboard port, but disable the keyboard intr. */
1046 if (setup_kbd_port(kbdc, TRUE, FALSE))
1047 /* CONTROLLER ERROR: there is very little we can do... */
1050 /* see if something is present */
1051 write_kbd_command(kbdc, KBDC_ECHO);
1052 if (read_kbd_data(kbdc) != KBD_ECHO) {
1053 empty_both_buffers(kbdc, 10);
1054 test_controller(kbdc);
1055 test_kbd_port(kbdc);
1059 /* enable the keyboard port and intr. */
1060 if (setup_kbd_port(kbdc, TRUE, TRUE)) {
1063 * This is serious; the keyboard intr is left disabled!
1072 probe_keyboard(KBDC kbdc, int flags)
1075 * Don't try to print anything in this function. The low-level
1076 * console may not have been initialized yet...
1082 if (!kbdc_lock(kbdc, TRUE)) {
1087 /* temporarily block data transmission from the keyboard */
1088 write_controller_command(kbdc, KBDC_DISABLE_KBD_PORT);
1090 /* flush any noise in the buffer */
1091 empty_both_buffers(kbdc, 100);
1093 /* save the current keyboard controller command byte */
1094 m = kbdc_get_device_mask(kbdc) & ~KBD_KBD_CONTROL_BITS;
1095 c = get_controller_command_byte(kbdc);
1097 /* CONTROLLER ERROR */
1098 kbdc_set_device_mask(kbdc, m);
1099 kbdc_lock(kbdc, FALSE);
1104 * The keyboard may have been screwed up by the boot block.
1105 * We may just be able to recover from error by testing the controller
1106 * and the keyboard port. The controller command byte needs to be
1107 * saved before this recovery operation, as some controllers seem
1108 * to set the command byte to particular values.
1110 test_controller(kbdc);
1111 test_kbd_port(kbdc);
1113 err = get_kbd_echo(kbdc);
1116 * Even if the keyboard doesn't seem to be present (err != 0),
1117 * we shall enable the keyboard port and interrupt so that
1118 * the driver will be operable when the keyboard is attached
1119 * to the system later. It is NOT recommended to hot-plug
1120 * the AT keyboard, but many people do so...
1122 kbdc_set_device_mask(kbdc, m | KBD_KBD_CONTROL_BITS);
1123 setup_kbd_port(kbdc, TRUE, TRUE);
1126 kbdc_set_device_mask(kbdc, m | KBD_KBD_CONTROL_BITS);
1128 /* try to restore the command byte as before */
1129 set_controller_command_byte(kbdc, 0xff, c);
1130 kbdc_set_device_mask(kbdc, m);
1134 kbdc_lock(kbdc, FALSE);
1139 init_keyboard(KBDC kbdc, int *type, int flags)
1145 if (!kbdc_lock(kbdc, TRUE)) {
1150 /* temporarily block data transmission from the keyboard */
1151 write_controller_command(kbdc, KBDC_DISABLE_KBD_PORT);
1153 /* save the current controller command byte */
1154 empty_both_buffers(kbdc, 200);
1155 c = get_controller_command_byte(kbdc);
1157 /* CONTROLLER ERROR */
1158 kbdc_lock(kbdc, FALSE);
1159 printf("atkbd: unable to get the current command byte value.\n");
1163 printf("atkbd: the current kbd controller command byte %04x\n",
1166 /* override the keyboard lock switch */
1167 c |= KBD_OVERRIDE_KBD_LOCK;
1170 /* enable the keyboard port, but disable the keyboard intr. */
1171 if (setup_kbd_port(kbdc, TRUE, FALSE)) {
1172 /* CONTROLLER ERROR: there is very little we can do... */
1173 printf("atkbd: unable to set the command byte.\n");
1174 kbdc_lock(kbdc, FALSE);
1179 * Check if we have an XT keyboard before we attempt to reset it.
1180 * The procedure assumes that the keyboard and the controller have
1181 * been set up properly by BIOS and have not been messed up
1182 * during the boot process.
1185 if (flags & KB_CONF_ALT_SCANCODESET)
1186 /* the user says there is a XT keyboard */
1188 #ifdef KBD_DETECT_XT_KEYBOARD
1189 else if ((c & KBD_TRANSLATION) == 0) {
1190 /* SET_SCANCODE_SET is not always supported; ignore error */
1191 if (send_kbd_command_and_data(kbdc, KBDC_SET_SCANCODE_SET, 0)
1193 codeset = read_kbd_data(kbdc);
1196 printf("atkbd: scancode set %d\n", codeset);
1197 #endif /* KBD_DETECT_XT_KEYBOARD */
1200 id = get_kbd_id(kbdc);
1202 case 0x41ab: /* 101/102/... Enhanced */
1203 case 0x83ab: /* ditto */
1204 case 0x54ab: /* SpaceSaver */
1205 case 0x84ab: /* ditto */
1207 case 0x90ab: /* 'G' */
1208 case 0x91ab: /* 'P' */
1209 case 0x92ab: /* 'A' */
1213 case -1: /* AT 84 keyboard doesn't return ID */
1220 printf("atkbd: keyboard ID 0x%x (%d)\n", id, *type);
1222 /* reset keyboard hardware */
1223 if (!(flags & KB_CONF_NO_RESET) && !reset_kbd(kbdc)) {
1226 * Keyboard reset may fail either because the keyboard
1227 * doen't exist, or because the keyboard doesn't pass
1228 * the self-test, or the keyboard controller on the
1229 * motherboard and the keyboard somehow fail to shake hands.
1230 * It is just possible, particularly in the last case,
1231 * that the keyoard controller may be left in a hung state.
1232 * test_controller() and test_kbd_port() appear to bring
1233 * the keyboard controller back (I don't know why and how,
1236 empty_both_buffers(kbdc, 10);
1237 test_controller(kbdc);
1238 test_kbd_port(kbdc);
1240 * We could disable the keyboard port and interrupt... but,
1241 * the keyboard may still exist (see above).
1243 set_controller_command_byte(kbdc, 0xff, c);
1244 kbdc_lock(kbdc, FALSE);
1246 printf("atkbd: failed to reset the keyboard.\n");
1251 * Allow us to set the XT_KEYBD flag in UserConfig so that keyboards
1252 * such as those on the IBM ThinkPad laptop computers can be used
1253 * with the standard console driver.
1256 if (send_kbd_command_and_data(kbdc,
1257 KBDC_SET_SCANCODE_SET, codeset) == KBD_ACK) {
1258 /* XT kbd doesn't need scan code translation */
1259 c &= ~KBD_TRANSLATION;
1263 * The XT kbd isn't usable unless the proper scan
1264 * code set is selected.
1266 set_controller_command_byte(kbdc, 0xff, c);
1267 kbdc_lock(kbdc, FALSE);
1268 printf("atkbd: unable to set the XT keyboard mode.\n");
1274 if (send_kbd_command_and_data(
1275 kbdc, KBDC_SET_SCANCODE_SET, 2) != KBD_ACK) {
1276 printf("atkbd: can't set translation.\n");
1279 c |= KBD_TRANSLATION;
1282 /* enable the keyboard port and intr. */
1283 if (!set_controller_command_byte(kbdc,
1284 KBD_KBD_CONTROL_BITS | KBD_TRANSLATION | KBD_OVERRIDE_KBD_LOCK,
1285 (c & (KBD_TRANSLATION | KBD_OVERRIDE_KBD_LOCK))
1286 | KBD_ENABLE_KBD_PORT | KBD_ENABLE_KBD_INT)) {
1289 * This is serious; we are left with the disabled
1292 set_controller_command_byte(kbdc, 0xff, c);
1293 kbdc_lock(kbdc, FALSE);
1294 printf("atkbd: unable to enable the keyboard port and intr.\n");
1298 kbdc_lock(kbdc, FALSE);
1303 write_kbd(KBDC kbdc, int command, int data)
1307 /* prevent the timeout routine from polling the keyboard */
1308 if (!kbdc_lock(kbdc, TRUE))
1311 /* disable the keyboard and mouse interrupt */
1314 c = get_controller_command_byte(kbdc);
1316 || !set_controller_command_byte(kbdc,
1317 kbdc_get_device_mask(kbdc),
1318 KBD_DISABLE_KBD_PORT | KBD_DISABLE_KBD_INT
1319 | KBD_DISABLE_AUX_PORT | KBD_DISABLE_AUX_INT)) {
1320 /* CONTROLLER ERROR */
1321 kbdc_lock(kbdc, FALSE);
1326 * Now that the keyboard controller is told not to generate
1327 * the keyboard and mouse interrupts, call `splx()' to allow
1328 * the other tty interrupts. The clock interrupt may also occur,
1329 * but the timeout routine (`scrn_timer()') will be blocked
1330 * by the lock flag set via `kbdc_lock()'
1335 if (send_kbd_command_and_data(kbdc, command, data) != KBD_ACK)
1336 send_kbd_command(kbdc, KBDC_ENABLE_KBD);
1339 /* restore the interrupts */
1340 if (!set_controller_command_byte(kbdc,
1341 kbdc_get_device_mask(kbdc),
1342 c & (KBD_KBD_CONTROL_BITS | KBD_AUX_CONTROL_BITS))) {
1343 /* CONTROLLER ERROR */
1348 kbdc_lock(kbdc, FALSE);
1354 get_kbd_id(KBDC kbdc)
1358 empty_both_buffers(kbdc, 10);
1360 if (send_kbd_command(kbdc, KBDC_SEND_DEV_ID) != KBD_ACK)
1363 DELAY(10000); /* 10 msec delay */
1364 id1 = read_kbd_data(kbdc);
1366 id2 = read_kbd_data(kbdc);
1368 if ((id1 == -1) || (id2 == -1)) {
1369 empty_both_buffers(kbdc, 10);
1370 test_controller(kbdc);
1371 test_kbd_port(kbdc);
1374 return ((id2 << 8) | id1);
1377 static int delays[] = { 250, 500, 750, 1000 };
1378 static int rates[] = { 34, 38, 42, 46, 50, 55, 59, 63,
1379 68, 76, 84, 92, 100, 110, 118, 126,
1380 136, 152, 168, 184, 200, 220, 236, 252,
1381 272, 304, 336, 368, 400, 440, 472, 504 };
1384 typematic_delay(int i)
1386 return delays[(i >> 5) & 3];
1390 typematic_rate(int i)
1392 return rates[i & 0x1f];
1396 typematic(int delay, int rate)
1401 for (i = sizeof(delays)/sizeof(delays[0]) - 1; i > 0; --i) {
1402 if (delay >= delays[i])
1406 for (i = sizeof(rates)/sizeof(rates[0]) - 1; i > 0; --i) {
1407 if (rate >= rates[i])