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.
28 * $FreeBSD: src/sys/dev/kbd/atkbd.c,v 1.25.2.4 2002/04/08 19:21:38 asmodai Exp $
31 * NOTE: All locks are handled by the kbd wrappers.
35 #include "opt_atkbd.h"
37 #include <sys/param.h>
38 #include <sys/systm.h>
39 #include <sys/kernel.h>
42 #include <sys/malloc.h>
43 #include <sys/thread2.h>
46 #include <machine/md_var.h>
47 #include <machine/psl.h>
48 #include <machine/vm86.h>
49 #include <machine/pc/bios.h>
58 #include "atkbdcreg.h"
60 #include <bus/isa/isareg.h>
62 static timeout_t atkbd_timeout;
65 atkbd_probe_unit(int unit, int ctlr, int irq, int flags)
67 keyboard_switch_t *sw;
71 sw = kbd_get_switch(ATKBD_DRIVER_NAME);
78 error = (*sw->probe)(unit, args, flags);
86 atkbd_attach_unit(int unit, keyboard_t **kbd, int ctlr, int irq, int flags)
88 keyboard_switch_t *sw;
92 sw = kbd_get_switch(ATKBD_DRIVER_NAME);
97 /* reset, initialize and enable the device */
101 error = (*sw->probe)(unit, args, flags);
105 error = (*sw->init)(unit, kbd, args, flags);
111 #ifdef KBD_INSTALL_CDEV
112 /* attach a virtual keyboard cdev */
113 error = kbd_attach(*kbd);
120 * This is a kludge to compensate for lost keyboard interrupts.
121 * A similar code used to be in syscons. See below. XXX
126 (*sw->diag)(*kbd, bootverbose);
132 atkbd_timeout(void *arg)
137 * The original text of the following comments are extracted
138 * from syscons.c (1.287)
140 * With release 2.1 of the Xaccel server, the keyboard is left
141 * hanging pretty often. Apparently an interrupt from the
142 * keyboard is lost, and I don't know why (yet).
143 * This ugly hack calls the low-level interrupt routine if input
144 * is ready for the keyboard and conveniently hides the problem. XXX
146 * Try removing anything stuck in the keyboard controller; whether
147 * it's a keyboard scan code or mouse data. The low-level
148 * interrupt routine doesn't read the mouse data directly,
149 * but the keyboard controller driver will, as a side effect.
152 * And here is bde's original comment about this:
154 * This is necessary to handle edge triggered interrupts - if we
155 * returned when our IRQ is high due to unserviced input, then there
156 * would be no more keyboard IRQs until the keyboard is reset by
159 * The keyboard apparently unwedges the irq in most cases.
162 kbd = (keyboard_t *)arg;
163 if (kbd_lock(kbd, TRUE)) {
165 * We have seen the lock flag is not set. Let's reset
166 * the flag early, otherwise the LED update routine fails
167 * which may want the lock during the interrupt routine.
169 kbd_lock(kbd, FALSE);
170 if (kbd_check_char(kbd))
173 callout_reset(&kbd->kb_atkbd_timeout_ch, hz / 10, atkbd_timeout, arg);
179 #include <machine/limits.h>
180 #include <machine/clock.h>
182 #define ATKBD_DEFAULT 0
184 typedef struct atkbd_state {
185 KBDC kbdc; /* keyboard controller */
186 int ks_mode; /* input mode (K_XLATE,K_RAW,K_CODE) */
187 int ks_flags; /* flags */
188 #define COMPOSE (1 << 0)
190 int ks_state; /* shift/lock key state */
191 int ks_accents; /* accent key index (> 0) */
192 u_int ks_composed_char; /* composed char code (> 0) */
193 u_char ks_prefix; /* AT scan code prefix */
196 /* keyboard driver declaration */
197 static int atkbd_configure(int flags);
198 static kbd_probe_t atkbd_probe;
199 static kbd_init_t atkbd_init;
200 static kbd_term_t atkbd_term;
201 static kbd_intr_t atkbd_intr;
202 static kbd_test_if_t atkbd_test_if;
203 static kbd_enable_t atkbd_enable;
204 static kbd_disable_t atkbd_disable;
205 static kbd_read_t atkbd_read;
206 static kbd_check_t atkbd_check;
207 static kbd_read_char_t atkbd_read_char;
208 static kbd_check_char_t atkbd_check_char;
209 static kbd_ioctl_t atkbd_ioctl;
210 static kbd_lock_t atkbd_lock;
211 static kbd_clear_state_t atkbd_clear_state;
212 static kbd_get_state_t atkbd_get_state;
213 static kbd_set_state_t atkbd_set_state;
214 static kbd_poll_mode_t atkbd_poll;
216 keyboard_switch_t atkbdsw = {
238 KEYBOARD_DRIVER(atkbd, atkbdsw, atkbd_configure);
240 /* local functions */
241 static int get_typematic(keyboard_t *kbd);
242 static int setup_kbd_port(KBDC kbdc, int port, int intr);
243 static int get_kbd_echo(KBDC kbdc);
244 static int probe_keyboard(KBDC kbdc, int flags);
245 static int init_keyboard(KBDC kbdc, int *type, int flags);
246 static int write_kbd(KBDC kbdc, int command, int data);
247 static int get_kbd_id(KBDC kbdc);
248 static int typematic(int delay, int rate);
249 static int typematic_delay(int delay);
250 static int typematic_rate(int rate);
252 /* local variables */
254 /* the initial key map, accent map and fkey strings */
255 #ifdef ATKBD_DFLT_KEYMAP
256 #define KBD_DFLT_KEYMAP
257 #include "atkbdmap.h"
259 #include "kbdtables.h"
261 /* structures for the default keyboard */
262 static keyboard_t default_kbd;
263 static atkbd_state_t default_kbd_state;
264 static keymap_t default_keymap;
265 static accentmap_t default_accentmap;
266 static fkeytab_t default_fkeytab[NUM_FKEYS];
269 * The back door to the keyboard driver!
270 * This function is called by the console driver, via the kbdio module,
271 * to tickle keyboard drivers when the low-level console is being initialized.
272 * Almost nothing in the kernel has been initialied yet. Try to probe
273 * keyboards if possible.
274 * NOTE: because of the way the low-level console is initialized, this routine
275 * may be called more than once!!
278 atkbd_configure(int flags)
285 * Probe the keyboard controller, if not present or if the driver
286 * is disabled, unregister the keyboard if any.
288 if (atkbdc_configure() != 0 ||
289 resource_disabled("atkbd", ATKBD_DEFAULT)) {
290 i = kbd_find_keyboard(ATKBD_DRIVER_NAME, ATKBD_DEFAULT);
292 kbd = kbd_get_keyboard(i);
293 KBD_ALWAYS_LOCK(kbd);
295 kbd = NULL; /* huh? */
300 /* XXX: a kludge to obtain the device configuration flags */
301 if (resource_int_value("atkbd", ATKBD_DEFAULT, "flags", &i) == 0)
304 /* probe the default keyboard */
308 if (atkbd_probe(ATKBD_DEFAULT, arg, flags)) {
311 if (atkbd_init(ATKBD_DEFAULT, &kbd, arg, flags)) {
315 /* return the number of found keyboards */
319 /* low-level functions */
321 /* detect a keyboard */
323 atkbd_probe(int unit, void *arg, int flags)
326 int *data = (int *)arg; /* data[0]: controller, data[1]: irq */
329 if (unit == ATKBD_DEFAULT) {
330 if (KBD_IS_PROBED(&default_kbd)) {
335 kbdc = atkbdc_open(data[0]);
339 if (probe_keyboard(kbdc, flags)) {
340 if (flags & KB_CONF_FAIL_IF_NO_KBD) {
348 /* reset and initialize the device */
350 atkbd_init(int unit, keyboard_t **kbdp, void *arg, int flags)
353 atkbd_state_t *state;
359 int *data = (int *)arg; /* data[0]: controller, data[1]: irq */
362 if (unit == ATKBD_DEFAULT) {
363 *kbdp = kbd = &default_kbd;
364 if (KBD_IS_INITIALIZED(kbd) && KBD_IS_CONFIGURED(kbd)) {
367 state = &default_kbd_state;
368 keymap = &default_keymap;
369 accmap = &default_accentmap;
370 fkeymap = default_fkeytab;
371 fkeymap_size = NELEM(default_fkeytab);
372 } else if (*kbdp == NULL) {
373 *kbdp = kbd = kmalloc(sizeof(*kbd), M_DEVBUF, M_WAITOK|M_ZERO);
374 state = kmalloc(sizeof(*state), M_DEVBUF, M_WAITOK|M_ZERO);
375 keymap = kmalloc(sizeof(key_map), M_DEVBUF, M_WAITOK);
376 accmap = kmalloc(sizeof(accent_map), M_DEVBUF, M_WAITOK);
377 fkeymap = kmalloc(sizeof(fkey_tab), M_DEVBUF, M_WAITOK);
378 fkeymap_size = NELEM(fkey_tab);
379 } else if (KBD_IS_INITIALIZED(*kbdp) && KBD_IS_CONFIGURED(*kbdp)) {
383 state = (atkbd_state_t *)kbd->kb_data;
384 bzero(state, sizeof(*state));
385 keymap = kbd->kb_keymap;
386 accmap = kbd->kb_accentmap;
387 fkeymap = kbd->kb_fkeytab;
388 fkeymap_size = kbd->kb_fkeytab_size;
391 if (!KBD_IS_PROBED(kbd)) {
392 state->kbdc = atkbdc_open(data[0]);
393 if (state->kbdc == NULL) {
396 kbd_init_struct(kbd, ATKBD_DRIVER_NAME, KB_OTHER, unit, flags,
398 bcopy(&key_map, keymap, sizeof(key_map));
399 bcopy(&accent_map, accmap, sizeof(accent_map));
400 bcopy(fkey_tab, fkeymap,
401 imin(fkeymap_size*sizeof(fkeymap[0]), sizeof(fkey_tab)));
402 kbd_set_maps(kbd, keymap, accmap, fkeymap, fkeymap_size);
403 kbd->kb_data = (void *)state;
405 if (probe_keyboard(state->kbdc, flags)) { /* shouldn't happen */
406 if (flags & KB_CONF_FAIL_IF_NO_KBD) {
410 KBD_FOUND_DEVICE(kbd);
412 atkbd_clear_state(kbd);
413 state->ks_mode = K_XLATE;
415 * FIXME: set the initial value for lock keys in ks_state
416 * according to the BIOS data?
420 if (!KBD_IS_INITIALIZED(kbd) && !(flags & KB_CONF_PROBE_ONLY)) {
421 kbd->kb_config = flags & ~KB_CONF_PROBE_ONLY;
422 if (KBD_HAS_DEVICE(kbd)
423 && init_keyboard(state->kbdc, &kbd->kb_type, kbd->kb_config)
424 && (kbd->kb_config & KB_CONF_FAIL_IF_NO_KBD)) {
427 atkbd_ioctl(kbd, KDSETLED, (caddr_t)&state->ks_state);
429 delay[0] = kbd->kb_delay1;
430 delay[1] = kbd->kb_delay2;
431 atkbd_ioctl(kbd, KDSETREPEAT, (caddr_t)delay);
434 if (!KBD_IS_CONFIGURED(kbd)) {
435 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);
490 /* test the interface to the device */
492 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)
521 /* disallow the access to the device */
523 atkbd_disable(keyboard_t *kbd)
531 /* read one byte from the keyboard if it's allowed */
533 atkbd_read(keyboard_t *kbd, int wait)
538 c = read_kbd_data(((atkbd_state_t *)kbd->kb_data)->kbdc);
540 c = read_kbd_data_no_wait(((atkbd_state_t *)kbd->kb_data)->kbdc);
544 ret = (KBD_IS_ACTIVE(kbd) ? c : -1);
549 /* check if data is waiting */
551 atkbd_check(keyboard_t *kbd)
556 if (!KBD_IS_ACTIVE(kbd)) {
559 ret = kbdc_data_ready(((atkbd_state_t *)kbd->kb_data)->kbdc);
564 /* read char from the keyboard */
566 atkbd_read_char(keyboard_t *kbd, int wait)
568 atkbd_state_t *state;
573 state = (atkbd_state_t *)kbd->kb_data;
575 /* do we have a composed char to return? */
576 if (!(state->ks_flags & COMPOSE) && (state->ks_composed_char > 0)) {
577 action = state->ks_composed_char;
578 state->ks_composed_char = 0;
579 if (action > UCHAR_MAX) {
585 /* see if there is something in the keyboard port */
588 scancode = read_kbd_data(state->kbdc);
589 } while (scancode == -1);
591 scancode = read_kbd_data_no_wait(state->kbdc);
592 if (scancode == -1) {
598 #if KBDIO_DEBUG >= 10
599 kprintf("atkbd_read_char(): scancode:0x%x\n", scancode);
602 /* return the byte as is for the K_RAW mode */
603 if (state->ks_mode == K_RAW) {
607 /* translate the scan code into a keycode */
608 keycode = scancode & 0x7F;
609 switch (state->ks_prefix) {
610 case 0x00: /* normal scancode */
612 case 0xB8: /* left alt (compose key) released */
613 if (state->ks_flags & COMPOSE) {
614 state->ks_flags &= ~COMPOSE;
615 if (state->ks_composed_char > UCHAR_MAX)
616 state->ks_composed_char = 0;
619 case 0x38: /* left alt (compose key) pressed */
620 if (!(state->ks_flags & COMPOSE)) {
621 state->ks_flags |= COMPOSE;
622 state->ks_composed_char = 0;
627 state->ks_prefix = scancode;
631 case 0xE0: /* 0xE0 prefix */
632 state->ks_prefix = 0;
634 case 0x1C: /* right enter key */
637 case 0x1D: /* right ctrl key */
640 case 0x35: /* keypad divide key */
643 case 0x37: /* print scrn key */
646 case 0x38: /* right alt key (alt gr) */
649 case 0x46: /* ctrl-pause/break on AT 101 (see below) */
652 case 0x47: /* grey home key */
655 case 0x48: /* grey up arrow key */
658 case 0x49: /* grey page up key */
661 case 0x4B: /* grey left arrow key */
664 case 0x4D: /* grey right arrow key */
667 case 0x4F: /* grey end key */
670 case 0x50: /* grey down arrow key */
673 case 0x51: /* grey page down key */
676 case 0x52: /* grey insert key */
679 case 0x53: /* grey delete key */
682 /* the following 3 are only used on the MS "Natural" keyboard */
683 case 0x5b: /* left Window key */
686 case 0x5c: /* right Window key */
689 case 0x5d: /* menu key */
692 default: /* ignore everything else */
696 case 0xE1: /* 0xE1 prefix */
698 * The pause/break key on the 101 keyboard produces:
700 * Ctrl-pause/break produces:
701 * E0-46 E0-C6 (See above.)
703 state->ks_prefix = 0;
705 state->ks_prefix = 0x1D;
708 case 0x1D: /* pause / break */
709 state->ks_prefix = 0;
716 if (kbd->kb_type == KB_84) {
718 case 0x37: /* *(numpad)/print screen */
719 if (state->ks_flags & SHIFTS)
720 keycode = 0x5c; /* print screen */
722 case 0x45: /* num lock/pause */
723 if (state->ks_flags & CTLS)
724 keycode = 0x68; /* pause */
726 case 0x46: /* scroll lock/break */
727 if (state->ks_flags & CTLS)
728 keycode = 0x6c; /* break */
731 } else if (kbd->kb_type == KB_101) {
733 case 0x5c: /* print screen */
734 if (state->ks_flags & ALTS)
735 keycode = 0x54; /* sysrq */
737 case 0x68: /* pause/break */
738 if (state->ks_flags & CTLS)
739 keycode = 0x6c; /* break */
744 /* return the key code in the K_CODE mode */
745 if (state->ks_mode == K_CODE) {
746 return (keycode | (scancode & 0x80));
749 /* compose a character code */
750 if (state->ks_flags & COMPOSE) {
751 switch (keycode | (scancode & 0x80)) {
752 /* key pressed, process it */
753 case 0x47: case 0x48: case 0x49: /* keypad 7,8,9 */
754 state->ks_composed_char *= 10;
755 state->ks_composed_char += keycode - 0x40;
756 if (state->ks_composed_char > UCHAR_MAX)
759 case 0x4B: case 0x4C: case 0x4D: /* keypad 4,5,6 */
760 state->ks_composed_char *= 10;
761 state->ks_composed_char += keycode - 0x47;
762 if (state->ks_composed_char > UCHAR_MAX)
765 case 0x4F: case 0x50: case 0x51: /* keypad 1,2,3 */
766 state->ks_composed_char *= 10;
767 state->ks_composed_char += keycode - 0x4E;
768 if (state->ks_composed_char > UCHAR_MAX)
771 case 0x52: /* keypad 0 */
772 state->ks_composed_char *= 10;
773 if (state->ks_composed_char > UCHAR_MAX)
777 /* key released, no interest here */
778 case 0xC7: case 0xC8: case 0xC9: /* keypad 7,8,9 */
779 case 0xCB: case 0xCC: case 0xCD: /* keypad 4,5,6 */
780 case 0xCF: case 0xD0: case 0xD1: /* keypad 1,2,3 */
781 case 0xD2: /* keypad 0 */
784 case 0x38: /* left alt key */
788 if (state->ks_composed_char > 0) {
789 state->ks_flags &= ~COMPOSE;
790 state->ks_composed_char = 0;
797 /* keycode to key action */
798 action = genkbd_keyaction(kbd, keycode, scancode & 0x80,
799 &state->ks_state, &state->ks_accents);
800 if (action == NOKEY) {
807 /* check if char is waiting */
809 atkbd_check_char(keyboard_t *kbd)
811 atkbd_state_t *state;
814 if (!KBD_IS_ACTIVE(kbd)) {
817 state = (atkbd_state_t *)kbd->kb_data;
818 if (!(state->ks_flags & COMPOSE) && (state->ks_composed_char > 0)) {
821 ret = kbdc_data_ready(state->kbdc);
825 /* some useful control functions */
827 atkbd_ioctl(keyboard_t *kbd, u_long cmd, caddr_t arg)
829 /* trasnlate LED_XXX bits into the device specific bits */
830 static u_char ledmap[8] = {
831 0, 4, 2, 6, 1, 5, 3, 7,
833 atkbd_state_t *state = kbd->kb_data;
841 case KDGKBMODE: /* get keyboard mode */
842 *(int *)arg = state->ks_mode;
844 case KDSKBMODE: /* set keyboard mode */
845 switch (*(int *)arg) {
847 if (state->ks_mode != K_XLATE) {
848 /* make lock key state and LED state match */
849 state->ks_state &= ~LOCK_MASK;
850 state->ks_state |= KBD_LED_VAL(kbd);
855 if (state->ks_mode != *(int *)arg) {
856 atkbd_clear_state(kbd);
857 state->ks_mode = *(int *)arg;
866 case KDGETLED: /* get keyboard LED */
867 *(int *)arg = KBD_LED_VAL(kbd);
869 case KDSETLED: /* set keyboard LED */
870 /* NOTE: lock key state in ks_state won't be changed */
871 if (*(int *)arg & ~LOCK_MASK) {
876 /* replace CAPS LED with ALTGR LED for ALTGR keyboards */
877 if (state->ks_mode == K_XLATE &&
878 kbd->kb_keymap->n_keys > ALTGR_OFFSET) {
884 if (KBD_HAS_DEVICE(kbd)) {
885 error = write_kbd(state->kbdc, KBDC_SET_LEDS,
886 ledmap[i & LED_MASK]);
892 KBD_LED_VAL(kbd) = *(int *)arg;
895 case KDGKBSTATE: /* get lock key state */
896 *(int *)arg = state->ks_state & LOCK_MASK;
898 case KDSKBSTATE: /* set lock key state */
899 if (*(int *)arg & ~LOCK_MASK) {
903 state->ks_state &= ~LOCK_MASK;
904 state->ks_state |= *(int *)arg;
906 /* set LEDs and quit */
907 return atkbd_ioctl(kbd, KDSETLED, arg);
909 case KDSETREPEAT: /* set keyboard repeat rate (new interface) */
911 if (!KBD_HAS_DEVICE(kbd)) {
914 i = typematic(((int *)arg)[0], ((int *)arg)[1]);
915 error = write_kbd(state->kbdc, KBDC_SET_TYPEMATIC, i);
917 kbd->kb_delay1 = typematic_delay(i);
918 kbd->kb_delay2 = typematic_rate(i);
922 case KDSETRAD: /* set keyboard repeat rate (old interface) */
924 if (!KBD_HAS_DEVICE(kbd)) {
927 error = write_kbd(state->kbdc, KBDC_SET_TYPEMATIC, *(int *)arg);
929 kbd->kb_delay1 = typematic_delay(*(int *)arg);
930 kbd->kb_delay2 = typematic_rate(*(int *)arg);
934 case PIO_KEYMAP: /* set keyboard translation table */
935 case PIO_KEYMAPENT: /* set keyboard translation table entry */
936 case PIO_DEADKEYMAP: /* set accent key translation table */
937 state->ks_accents = 0;
941 return genkbd_commonioctl(kbd, cmd, arg);
948 /* lock the access to the keyboard */
950 atkbd_lock(keyboard_t *kbd, int lock)
952 return kbdc_lock(((atkbd_state_t *)kbd->kb_data)->kbdc, lock);
955 /* clear the internal state of the keyboard */
957 atkbd_clear_state(keyboard_t *kbd)
959 atkbd_state_t *state;
961 state = (atkbd_state_t *)kbd->kb_data;
963 state->ks_polling = 0;
964 state->ks_state &= LOCK_MASK; /* preserve locking key state */
965 state->ks_accents = 0;
966 state->ks_composed_char = 0;
968 state->ks_prefix = 0; /* XXX */
972 /* save the internal state */
974 atkbd_get_state(keyboard_t *kbd, void *buf, size_t len)
977 return sizeof(atkbd_state_t);
978 if (len < sizeof(atkbd_state_t))
981 bcopy(kbd->kb_data, buf, sizeof(atkbd_state_t));
985 /* set the internal state */
987 atkbd_set_state(keyboard_t *kbd, void *buf, size_t len)
989 if (len < sizeof(atkbd_state_t))
991 if (((atkbd_state_t *)kbd->kb_data)->kbdc
992 != ((atkbd_state_t *)buf)->kbdc)
994 bcopy(buf, kbd->kb_data, sizeof(atkbd_state_t));
999 atkbd_poll(keyboard_t *kbd, int on)
1001 atkbd_state_t *state;
1003 state = (atkbd_state_t *)kbd->kb_data;
1006 state->ks_polling = 1;
1008 state->ks_polling = 0;
1013 /* local functions */
1016 get_typematic(keyboard_t *kbd)
1020 * Only some systems allow us to retrieve the keyboard repeat
1021 * rate previously set via the BIOS...
1023 struct vm86frame vmf;
1026 bzero(&vmf, sizeof(vmf));
1027 vmf.vmf_ax = 0xc000;
1028 vm86_intcall(0x15, &vmf);
1029 if ((vmf.vmf_eflags & PSL_C) || vmf.vmf_ah)
1031 p = BIOS_PADDRTOVADDR(((u_int32_t)vmf.vmf_es << 4) + vmf.vmf_bx);
1032 if ((readb(p + 6) & 0x40) == 0) /* int 16, function 0x09 supported? */
1034 vmf.vmf_ax = 0x0900;
1035 vm86_intcall(0x16, &vmf);
1036 if ((vmf.vmf_al & 0x08) == 0) /* int 16, function 0x0306 supported? */
1038 vmf.vmf_ax = 0x0306;
1039 vm86_intcall(0x16, &vmf);
1040 kbd->kb_delay1 = typematic_delay(vmf.vmf_bh << 5);
1041 kbd->kb_delay2 = typematic_rate(vmf.vmf_bl);
1045 #endif /* __i386__ */
1049 setup_kbd_port(KBDC kbdc, int port, int intr)
1051 if (!set_controller_command_byte(kbdc,
1052 KBD_KBD_CONTROL_BITS,
1053 ((port) ? KBD_ENABLE_KBD_PORT : KBD_DISABLE_KBD_PORT)
1054 | ((intr) ? KBD_ENABLE_KBD_INT : KBD_DISABLE_KBD_INT)))
1060 get_kbd_echo(KBDC kbdc)
1062 /* enable the keyboard port, but disable the keyboard intr. */
1063 if (setup_kbd_port(kbdc, TRUE, FALSE))
1064 /* CONTROLLER ERROR: there is very little we can do... */
1067 /* see if something is present */
1068 write_kbd_command(kbdc, KBDC_ECHO);
1069 if (read_kbd_data(kbdc) != KBD_ECHO) {
1070 empty_both_buffers(kbdc, 10);
1071 test_controller(kbdc);
1072 test_kbd_port(kbdc);
1076 /* enable the keyboard port and intr. */
1077 if (setup_kbd_port(kbdc, TRUE, TRUE)) {
1080 * This is serious; the keyboard intr is left disabled!
1089 probe_keyboard(KBDC kbdc, int flags)
1092 * Don't try to print anything in this function. The low-level
1093 * console may not have been initialized yet...
1099 if (!kbdc_lock(kbdc, TRUE)) {
1104 /* temporarily block data transmission from the keyboard */
1105 write_controller_command(kbdc, KBDC_DISABLE_KBD_PORT);
1107 /* flush any noise in the buffer */
1108 empty_both_buffers(kbdc, 100);
1110 /* save the current keyboard controller command byte */
1111 m = kbdc_get_device_mask(kbdc) & ~KBD_KBD_CONTROL_BITS;
1112 c = get_controller_command_byte(kbdc);
1114 /* CONTROLLER ERROR */
1115 kbdc_set_device_mask(kbdc, m);
1116 kbdc_lock(kbdc, FALSE);
1121 * The keyboard may have been screwed up by the boot block.
1122 * We may just be able to recover from error by testing the controller
1123 * and the keyboard port. The controller command byte needs to be
1124 * saved before this recovery operation, as some controllers seem
1125 * to set the command byte to particular values.
1127 test_controller(kbdc);
1128 test_kbd_port(kbdc);
1130 err = get_kbd_echo(kbdc);
1133 * Even if the keyboard doesn't seem to be present (err != 0),
1134 * we shall enable the keyboard port and interrupt so that
1135 * the driver will be operable when the keyboard is attached
1136 * to the system later. It is NOT recommended to hot-plug
1137 * the AT keyboard, but many people do so...
1139 kbdc_set_device_mask(kbdc, m | KBD_KBD_CONTROL_BITS);
1140 setup_kbd_port(kbdc, TRUE, TRUE);
1143 kbdc_set_device_mask(kbdc, m | KBD_KBD_CONTROL_BITS);
1145 /* try to restore the command byte as before */
1146 set_controller_command_byte(kbdc, 0xff, c);
1147 kbdc_set_device_mask(kbdc, m);
1151 kbdc_lock(kbdc, FALSE);
1156 init_keyboard(KBDC kbdc, int *type, int flags)
1162 if (!kbdc_lock(kbdc, TRUE)) {
1167 /* temporarily block data transmission from the keyboard */
1168 write_controller_command(kbdc, KBDC_DISABLE_KBD_PORT);
1170 /* save the current controller command byte */
1171 empty_both_buffers(kbdc, 200);
1172 c = get_controller_command_byte(kbdc);
1174 /* CONTROLLER ERROR */
1175 kbdc_lock(kbdc, FALSE);
1176 kprintf("atkbd: unable to get the current command byte value.\n");
1180 kprintf("atkbd: the current kbd controller command byte %04x\n",
1183 /* override the keyboard lock switch */
1184 c |= KBD_OVERRIDE_KBD_LOCK;
1187 /* enable the keyboard port, but disable the keyboard intr. */
1188 if (setup_kbd_port(kbdc, TRUE, FALSE)) {
1189 /* CONTROLLER ERROR: there is very little we can do... */
1190 kprintf("atkbd: unable to set the command byte.\n");
1191 kbdc_lock(kbdc, FALSE);
1196 * Check if we have an XT keyboard before we attempt to reset it.
1197 * The procedure assumes that the keyboard and the controller have
1198 * been set up properly by BIOS and have not been messed up
1199 * during the boot process.
1202 if (flags & KB_CONF_ALT_SCANCODESET)
1203 /* the user says there is a XT keyboard */
1205 #ifdef KBD_DETECT_XT_KEYBOARD
1206 else if ((c & KBD_TRANSLATION) == 0) {
1207 /* SET_SCANCODE_SET is not always supported; ignore error */
1208 if (send_kbd_command_and_data(kbdc, KBDC_SET_SCANCODE_SET, 0)
1210 codeset = read_kbd_data(kbdc);
1213 kprintf("atkbd: scancode set %d\n", codeset);
1214 #endif /* KBD_DETECT_XT_KEYBOARD */
1217 id = get_kbd_id(kbdc);
1219 case 0x41ab: /* 101/102/... Enhanced */
1220 case 0x83ab: /* ditto */
1221 case 0x54ab: /* SpaceSaver */
1222 case 0x84ab: /* ditto */
1224 case 0x90ab: /* 'G' */
1225 case 0x91ab: /* 'P' */
1226 case 0x92ab: /* 'A' */
1230 case -1: /* AT 84 keyboard doesn't return ID */
1237 kprintf("atkbd: keyboard ID 0x%x (%d)\n", id, *type);
1239 /* reset keyboard hardware */
1240 if (!(flags & KB_CONF_NO_RESET) && !reset_kbd(kbdc)) {
1243 * Keyboard reset may fail either because the keyboard
1244 * doen't exist, or because the keyboard doesn't pass
1245 * the self-test, or the keyboard controller on the
1246 * motherboard and the keyboard somehow fail to shake hands.
1247 * It is just possible, particularly in the last case,
1248 * that the keyoard controller may be left in a hung state.
1249 * test_controller() and test_kbd_port() appear to bring
1250 * the keyboard controller back (I don't know why and how,
1253 empty_both_buffers(kbdc, 10);
1254 test_controller(kbdc);
1255 test_kbd_port(kbdc);
1257 * We could disable the keyboard port and interrupt... but,
1258 * the keyboard may still exist (see above).
1260 set_controller_command_byte(kbdc, 0xff, c);
1261 kbdc_lock(kbdc, FALSE);
1263 kprintf("atkbd: failed to reset the keyboard.\n");
1268 * Allow us to set the XT_KEYBD flag in UserConfig so that keyboards
1269 * such as those on the IBM ThinkPad laptop computers can be used
1270 * with the standard console driver.
1273 if (send_kbd_command_and_data(kbdc,
1274 KBDC_SET_SCANCODE_SET, codeset) == KBD_ACK) {
1275 /* XT kbd doesn't need scan code translation */
1276 c &= ~KBD_TRANSLATION;
1280 * The XT kbd isn't usable unless the proper scan
1281 * code set is selected.
1283 set_controller_command_byte(kbdc, 0xff, c);
1284 kbdc_lock(kbdc, FALSE);
1285 kprintf("atkbd: unable to set the XT keyboard mode.\n");
1290 /* enable the keyboard port and intr. */
1291 if (!set_controller_command_byte(kbdc,
1292 KBD_KBD_CONTROL_BITS | KBD_TRANSLATION | KBD_OVERRIDE_KBD_LOCK,
1293 (c & (KBD_TRANSLATION | KBD_OVERRIDE_KBD_LOCK))
1294 | KBD_ENABLE_KBD_PORT | KBD_ENABLE_KBD_INT)) {
1297 * This is serious; we are left with the disabled
1300 set_controller_command_byte(kbdc, 0xff, c);
1301 kbdc_lock(kbdc, FALSE);
1302 kprintf("atkbd: unable to enable the keyboard port and intr.\n");
1306 kbdc_lock(kbdc, FALSE);
1311 write_kbd(KBDC kbdc, int command, int data)
1313 /* prevent the timeout routine from polling the keyboard */
1314 if (!kbdc_lock(kbdc, TRUE))
1317 /* disable the keyboard and mouse interrupt */
1320 c = get_controller_command_byte(kbdc);
1322 || !set_controller_command_byte(kbdc,
1323 kbdc_get_device_mask(kbdc),
1324 KBD_DISABLE_KBD_PORT | KBD_DISABLE_KBD_INT
1325 | KBD_DISABLE_AUX_PORT | KBD_DISABLE_AUX_INT)) {
1326 /* CONTROLLER ERROR */
1327 kbdc_lock(kbdc, FALSE);
1332 * Now that the keyboard controller is told not to generate
1333 * the keyboard and mouse interrupts, call `splx()' to allow
1334 * the other tty interrupts. The clock interrupt may also occur,
1335 * but the timeout routine (`scrn_timer()') will be blocked
1336 * by the lock flag set via `kbdc_lock()'
1341 if (send_kbd_command_and_data(kbdc, command, data) != KBD_ACK)
1342 send_kbd_command(kbdc, KBDC_ENABLE_KBD);
1345 /* restore the interrupts */
1346 if (!set_controller_command_byte(kbdc,
1347 kbdc_get_device_mask(kbdc),
1348 c & (KBD_KBD_CONTROL_BITS | KBD_AUX_CONTROL_BITS))) {
1349 /* CONTROLLER ERROR */
1354 kbdc_lock(kbdc, FALSE);
1360 get_kbd_id(KBDC kbdc)
1364 empty_both_buffers(kbdc, 10);
1366 if (send_kbd_command(kbdc, KBDC_SEND_DEV_ID) != KBD_ACK)
1369 DELAY(10000); /* 10 msec delay */
1370 id1 = read_kbd_data(kbdc);
1372 id2 = read_kbd_data(kbdc);
1374 if ((id1 == -1) || (id2 == -1)) {
1375 empty_both_buffers(kbdc, 10);
1376 test_controller(kbdc);
1377 test_kbd_port(kbdc);
1380 return ((id2 << 8) | id1);
1383 static int delays[] = { 250, 500, 750, 1000 };
1384 static int rates[] = { 34, 38, 42, 46, 50, 55, 59, 63,
1385 68, 76, 84, 92, 100, 110, 118, 126,
1386 136, 152, 168, 184, 200, 220, 236, 252,
1387 272, 304, 336, 368, 400, 440, 472, 504 };
1390 typematic_delay(int i)
1392 return delays[(i >> 5) & 3];
1396 typematic_rate(int i)
1398 return rates[i & 0x1f];
1402 typematic(int delay, int rate)
1407 for (i = NELEM(delays) - 1; i > 0; --i) {
1408 if (delay >= delays[i])
1412 for (i = NELEM(rates) - 1; i > 0; --i) {
1413 if (rate >= rates[i])