xref: /freebsd/sys/dev/atkbdc/atkbd.c (revision d4eeb02986980bf33dd56c41ceb9fc5f180c0d47)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3  *
4  * Copyright (c) 1999 Kazutaka YOKOTA <yokota@zodiac.mech.utsunomiya-u.ac.jp>
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
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.
16  *
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.
27  *
28  */
29 
30 #include <sys/cdefs.h>
31 __FBSDID("$FreeBSD$");
32 
33 #include "opt_kbd.h"
34 #include "opt_atkbd.h"
35 #include "opt_evdev.h"
36 
37 #include <sys/param.h>
38 #include <sys/systm.h>
39 #include <sys/kernel.h>
40 #include <sys/bus.h>
41 #include <sys/eventhandler.h>
42 #include <sys/proc.h>
43 #include <sys/limits.h>
44 #include <sys/malloc.h>
45 #include <sys/sysctl.h>
46 
47 #include <machine/bus.h>
48 #include <machine/resource.h>
49 
50 #include <sys/kbio.h>
51 #include <dev/kbd/kbdreg.h>
52 #include <dev/atkbdc/atkbdreg.h>
53 #include <dev/atkbdc/atkbdcreg.h>
54 
55 #ifdef EVDEV_SUPPORT
56 #include <dev/evdev/evdev.h>
57 #include <dev/evdev/input.h>
58 #endif
59 
60 typedef struct atkbd_state {
61 	KBDC		kbdc;		/* keyboard controller */
62 	int		ks_mode;	/* input mode (K_XLATE,K_RAW,K_CODE) */
63 	int		ks_flags;	/* flags */
64 #define COMPOSE		(1 << 0)
65 	int		ks_polling;
66 	int		ks_state;	/* shift/lock key state */
67 	int		ks_accents;	/* accent key index (> 0) */
68 	u_int		ks_composed_char; /* composed char code (> 0) */
69 	u_char		ks_prefix;	/* AT scan code prefix */
70 	struct callout	ks_timer;
71 #ifdef EVDEV_SUPPORT
72 	struct evdev_dev *ks_evdev;
73 	int		ks_evdev_state;
74 #endif
75 } atkbd_state_t;
76 
77 static SYSCTL_NODE(_hw, OID_AUTO, atkbd, CTLFLAG_RD | CTLFLAG_MPSAFE, 0,
78     "AT keyboard");
79 
80 static int atkbdhz = 0;
81 SYSCTL_INT(_hw_atkbd, OID_AUTO, hz, CTLFLAG_RWTUN, &atkbdhz, 0,
82     "Polling frequency (in hz)");
83 
84 static void		atkbd_timeout(void *arg);
85 static int		atkbd_reset(KBDC kbdc, int flags, int c);
86 
87 #define HAS_QUIRK(p, q)		(((atkbdc_softc_t *)(p))->quirks & q)
88 #define ALLOW_DISABLE_KBD(kbdc)	!HAS_QUIRK(kbdc, KBDC_QUIRK_KEEP_ACTIVATED)
89 
90 #define DEFAULT_DELAY		0x1  /* 500ms */
91 #define DEFAULT_RATE		0x10 /* 14Hz */
92 
93 #ifdef EVDEV_SUPPORT
94 #define PS2_KEYBOARD_VENDOR	1
95 #define PS2_KEYBOARD_PRODUCT	1
96 #endif
97 
98 int
99 atkbd_probe_unit(device_t dev, int irq, int flags)
100 {
101 	keyboard_switch_t *sw;
102 	int args[2];
103 	int error;
104 
105 	sw = kbd_get_switch(ATKBD_DRIVER_NAME);
106 	if (sw == NULL)
107 		return ENXIO;
108 
109 	args[0] = device_get_unit(device_get_parent(dev));
110 	args[1] = irq;
111 	error = (*sw->probe)(device_get_unit(dev), args, flags);
112 	if (error)
113 		return error;
114 	return 0;
115 }
116 
117 int
118 atkbd_attach_unit(device_t dev, keyboard_t **kbd, int irq, int flags)
119 {
120 	keyboard_switch_t *sw;
121 	atkbd_state_t *state;
122 	int args[2];
123 	int error;
124 	int unit;
125 
126 	sw = kbd_get_switch(ATKBD_DRIVER_NAME);
127 	if (sw == NULL)
128 		return ENXIO;
129 
130 	/* reset, initialize and enable the device */
131 	unit = device_get_unit(dev);
132 	args[0] = device_get_unit(device_get_parent(dev));
133 	args[1] = irq;
134 	*kbd = NULL;
135 	error = (*sw->probe)(unit, args, flags);
136 	if (error)
137 		return error;
138 	error = (*sw->init)(unit, kbd, args, flags);
139 	if (error)
140 		return error;
141 	(*sw->enable)(*kbd);
142 
143 #ifdef KBD_INSTALL_CDEV
144 	/* attach a virtual keyboard cdev */
145 	error = kbd_attach(*kbd);
146 	if (error)
147 		return error;
148 #endif
149 
150 	/*
151 	 * This is a kludge to compensate for lost keyboard interrupts.
152 	 * A similar code used to be in syscons. See below. XXX
153 	 */
154 	state = (atkbd_state_t *)(*kbd)->kb_data;
155 	callout_init(&state->ks_timer, 0);
156 	atkbd_timeout(*kbd);
157 
158 	if (bootverbose)
159 		(*sw->diag)(*kbd, bootverbose);
160 
161 	return 0;
162 }
163 
164 static void
165 atkbd_timeout(void *arg)
166 {
167 	atkbd_state_t *state;
168 	keyboard_t *kbd;
169 	int s;
170 
171 	/*
172 	 * The original text of the following comments are extracted
173 	 * from syscons.c (1.287)
174 	 *
175 	 * With release 2.1 of the Xaccel server, the keyboard is left
176 	 * hanging pretty often. Apparently an interrupt from the
177 	 * keyboard is lost, and I don't know why (yet).
178 	 * This ugly hack calls the low-level interrupt routine if input
179 	 * is ready for the keyboard and conveniently hides the problem. XXX
180 	 *
181 	 * Try removing anything stuck in the keyboard controller; whether
182 	 * it's a keyboard scan code or mouse data. The low-level
183 	 * interrupt routine doesn't read the mouse data directly,
184 	 * but the keyboard controller driver will, as a side effect.
185 	 */
186 	/*
187 	 * And here is bde's original comment about this:
188 	 *
189 	 * This is necessary to handle edge triggered interrupts - if we
190 	 * returned when our IRQ is high due to unserviced input, then there
191 	 * would be no more keyboard IRQs until the keyboard is reset by
192 	 * external powers.
193 	 *
194 	 * The keyboard apparently unwedges the irq in most cases.
195 	 */
196 	s = spltty();
197 	kbd = (keyboard_t *)arg;
198 	if (kbdd_lock(kbd, TRUE)) {
199 		/*
200 		 * We have seen the lock flag is not set. Let's reset
201 		 * the flag early, otherwise the LED update routine fails
202 		 * which may want the lock during the interrupt routine.
203 		 */
204 		kbdd_lock(kbd, FALSE);
205 		if (kbdd_check_char(kbd))
206 			kbdd_intr(kbd, NULL);
207 	}
208 	splx(s);
209 	if (atkbdhz > 0) {
210 		state = (atkbd_state_t *)kbd->kb_data;
211 		callout_reset_sbt(&state->ks_timer, SBT_1S / atkbdhz, 0,
212 		    atkbd_timeout, arg, C_PREL(1));
213 	}
214 }
215 
216 /* LOW-LEVEL */
217 
218 #define ATKBD_DEFAULT	0
219 
220 /* keyboard driver declaration */
221 static int		atkbd_configure(int flags);
222 static kbd_probe_t	atkbd_probe;
223 static kbd_init_t	atkbd_init;
224 static kbd_term_t	atkbd_term;
225 static kbd_intr_t	atkbd_intr;
226 static kbd_test_if_t	atkbd_test_if;
227 static kbd_enable_t	atkbd_enable;
228 static kbd_disable_t	atkbd_disable;
229 static kbd_read_t	atkbd_read;
230 static kbd_check_t	atkbd_check;
231 static kbd_read_char_t	atkbd_read_char;
232 static kbd_check_char_t	atkbd_check_char;
233 static kbd_ioctl_t	atkbd_ioctl;
234 static kbd_lock_t	atkbd_lock;
235 static kbd_clear_state_t atkbd_clear_state;
236 static kbd_get_state_t	atkbd_get_state;
237 static kbd_set_state_t	atkbd_set_state;
238 static kbd_poll_mode_t	atkbd_poll;
239 
240 static keyboard_switch_t atkbdsw = {
241 	.probe =	atkbd_probe,
242 	.init =		atkbd_init,
243 	.term =		atkbd_term,
244 	.intr =		atkbd_intr,
245 	.test_if =	atkbd_test_if,
246 	.enable =	atkbd_enable,
247 	.disable =	atkbd_disable,
248 	.read =		atkbd_read,
249 	.check =	atkbd_check,
250 	.read_char =	atkbd_read_char,
251 	.check_char =	atkbd_check_char,
252 	.ioctl =	atkbd_ioctl,
253 	.lock =		atkbd_lock,
254 	.clear_state =	atkbd_clear_state,
255 	.get_state =	atkbd_get_state,
256 	.set_state =	atkbd_set_state,
257 	.poll =		atkbd_poll,
258 };
259 
260 KEYBOARD_DRIVER(atkbd, atkbdsw, atkbd_configure);
261 
262 /* local functions */
263 static int		set_typematic(keyboard_t *kbd);
264 static int		setup_kbd_port(KBDC kbdc, int port, int intr);
265 static int		get_kbd_echo(KBDC kbdc);
266 static int		probe_keyboard(KBDC kbdc, int flags);
267 static int		init_keyboard(KBDC kbdc, int *type, int flags);
268 static int		write_kbd(KBDC kbdc, int command, int data);
269 static int		get_kbd_id(KBDC kbdc);
270 static int		typematic(int delay, int rate);
271 static int		typematic_delay(int delay);
272 static int		typematic_rate(int rate);
273 
274 #ifdef EVDEV_SUPPORT
275 static evdev_event_t atkbd_ev_event;
276 
277 static const struct evdev_methods atkbd_evdev_methods = {
278 	.ev_event = atkbd_ev_event,
279 };
280 #endif
281 
282 /* local variables */
283 
284 /* the initial key map, accent map and fkey strings */
285 #ifdef ATKBD_DFLT_KEYMAP
286 #define KBD_DFLT_KEYMAP
287 #include "atkbdmap.h"
288 #endif
289 #include <dev/kbd/kbdtables.h>
290 
291 /* structures for the default keyboard */
292 static keyboard_t	default_kbd;
293 static atkbd_state_t	default_kbd_state;
294 static keymap_t		default_keymap;
295 static accentmap_t	default_accentmap;
296 static fkeytab_t	default_fkeytab[NUM_FKEYS];
297 
298 /*
299  * The back door to the keyboard driver!
300  * This function is called by the console driver, via the kbdio module,
301  * to tickle keyboard drivers when the low-level console is being initialized.
302  * Almost nothing in the kernel has been initialied yet.  Try to probe
303  * keyboards if possible.
304  * NOTE: because of the way the low-level console is initialized, this routine
305  * may be called more than once!!
306  */
307 static int
308 atkbd_configure(int flags)
309 {
310 	keyboard_t *kbd;
311 	int arg[2];
312 	int i;
313 
314 	/*
315 	 * Probe the keyboard controller, if not present or if the driver
316 	 * is disabled, unregister the keyboard if any.
317 	 */
318 	if (atkbdc_configure() != 0 ||
319 	    resource_disabled("atkbd", ATKBD_DEFAULT)) {
320 		i = kbd_find_keyboard(ATKBD_DRIVER_NAME, ATKBD_DEFAULT);
321 		if (i >= 0) {
322 			kbd = kbd_get_keyboard(i);
323 			kbd_unregister(kbd);
324 			kbd->kb_flags &= ~KB_REGISTERED;
325 		}
326 		return 0;
327 	}
328 
329 	/* XXX: a kludge to obtain the device configuration flags */
330 	if (resource_int_value("atkbd", ATKBD_DEFAULT, "flags", &i) == 0)
331 		flags |= i;
332 
333 	/* probe the default keyboard */
334 	arg[0] = -1;
335 	arg[1] = -1;
336 	kbd = NULL;
337 	if (atkbd_probe(ATKBD_DEFAULT, arg, flags))
338 		return 0;
339 	if (atkbd_init(ATKBD_DEFAULT, &kbd, arg, flags))
340 		return 0;
341 
342 	/* return the number of found keyboards */
343 	return 1;
344 }
345 
346 /* low-level functions */
347 
348 /* detect a keyboard */
349 static int
350 atkbd_probe(int unit, void *arg, int flags)
351 {
352 	KBDC kbdc;
353 	int *data = (int *)arg;	/* data[0]: controller, data[1]: irq */
354 
355 	/* XXX */
356 	if (unit == ATKBD_DEFAULT) {
357 		if (KBD_IS_PROBED(&default_kbd))
358 			return 0;
359 	}
360 
361 	kbdc = atkbdc_open(data[0]);
362 	if (kbdc == NULL)
363 		return ENXIO;
364 	if (probe_keyboard(kbdc, flags)) {
365 		if (flags & KB_CONF_FAIL_IF_NO_KBD)
366 			return ENXIO;
367 	}
368 	return 0;
369 }
370 
371 /* reset and initialize the device */
372 static int
373 atkbd_init(int unit, keyboard_t **kbdp, void *arg, int flags)
374 {
375 	keyboard_t *kbd;
376 	atkbd_state_t *state;
377 	keymap_t *keymap;
378 	accentmap_t *accmap;
379 	fkeytab_t *fkeymap;
380 	int fkeymap_size;
381 	int delay[2];
382 	int *data = (int *)arg;	/* data[0]: controller, data[1]: irq */
383 	int error, needfree;
384 #ifdef EVDEV_SUPPORT
385 	struct evdev_dev *evdev;
386 	char phys_loc[8];
387 #endif
388 
389 	/* XXX */
390 	if (unit == ATKBD_DEFAULT) {
391 		*kbdp = kbd = &default_kbd;
392 		if (KBD_IS_INITIALIZED(kbd) && KBD_IS_CONFIGURED(kbd))
393 			return 0;
394 		state = &default_kbd_state;
395 		keymap = &default_keymap;
396 		accmap = &default_accentmap;
397 		fkeymap = default_fkeytab;
398 		fkeymap_size = nitems(default_fkeytab);
399 		needfree = 0;
400 	} else if (*kbdp == NULL) {
401 		*kbdp = kbd = malloc(sizeof(*kbd), M_DEVBUF, M_NOWAIT | M_ZERO);
402 		state = malloc(sizeof(*state), M_DEVBUF, M_NOWAIT | M_ZERO);
403 		/* NB: these will always be initialized 'cuz !KBD_IS_PROBED */
404 		keymap = malloc(sizeof(key_map), M_DEVBUF, M_NOWAIT);
405 		accmap = malloc(sizeof(accent_map), M_DEVBUF, M_NOWAIT);
406 		fkeymap = malloc(sizeof(fkey_tab), M_DEVBUF, M_NOWAIT);
407 		fkeymap_size = sizeof(fkey_tab)/sizeof(fkey_tab[0]);
408 		needfree = 1;
409 		if ((kbd == NULL) || (state == NULL) || (keymap == NULL)
410 		     || (accmap == NULL) || (fkeymap == NULL)) {
411 			error = ENOMEM;
412 			goto bad;
413 		}
414 	} else if (KBD_IS_INITIALIZED(*kbdp) && KBD_IS_CONFIGURED(*kbdp)) {
415 		return 0;
416 	} else {
417 		kbd = *kbdp;
418 		state = (atkbd_state_t *)kbd->kb_data;
419 		bzero(state, sizeof(*state));
420 		keymap = kbd->kb_keymap;
421 		accmap = kbd->kb_accentmap;
422 		fkeymap = kbd->kb_fkeytab;
423 		fkeymap_size = kbd->kb_fkeytab_size;
424 		needfree = 0;
425 	}
426 
427 	if (!KBD_IS_PROBED(kbd)) {
428 		state->kbdc = atkbdc_open(data[0]);
429 		if (state->kbdc == NULL) {
430 			error = ENXIO;
431 			goto bad;
432 		}
433 		kbd_init_struct(kbd, ATKBD_DRIVER_NAME, KB_OTHER, unit, flags,
434 				0, 0);
435 		bcopy(&key_map, keymap, sizeof(key_map));
436 		bcopy(&accent_map, accmap, sizeof(accent_map));
437 		bcopy(fkey_tab, fkeymap,
438 		    imin(fkeymap_size * sizeof(fkeymap[0]), sizeof(fkey_tab)));
439 		kbd_set_maps(kbd, keymap, accmap, fkeymap, fkeymap_size);
440 		kbd->kb_data = (void *)state;
441 
442 		if (probe_keyboard(state->kbdc, flags)) { /* shouldn't happen */
443 			if (flags & KB_CONF_FAIL_IF_NO_KBD) {
444 				error = ENXIO;
445 				goto bad;
446 			}
447 		} else {
448 			KBD_FOUND_DEVICE(kbd);
449 		}
450 		atkbd_clear_state(kbd);
451 		state->ks_mode = K_XLATE;
452 		/*
453 		 * FIXME: set the initial value for lock keys in ks_state
454 		 * according to the BIOS data?
455 		 */
456 		KBD_PROBE_DONE(kbd);
457 	}
458 	if (!KBD_IS_INITIALIZED(kbd) && !(flags & KB_CONF_PROBE_ONLY)) {
459 		kbd->kb_config = flags & ~KB_CONF_PROBE_ONLY;
460 		if (KBD_HAS_DEVICE(kbd)
461 		    && init_keyboard(state->kbdc, &kbd->kb_type, kbd->kb_config)
462 		    && (kbd->kb_config & KB_CONF_FAIL_IF_NO_KBD)) {
463 			kbd_unregister(kbd);
464 			error = ENXIO;
465 			goto bad;
466 		}
467 		atkbd_ioctl(kbd, KDSETLED, (caddr_t)&state->ks_state);
468 		set_typematic(kbd);
469 		delay[0] = kbd->kb_delay1;
470 		delay[1] = kbd->kb_delay2;
471 		atkbd_ioctl(kbd, KDSETREPEAT, (caddr_t)delay);
472 
473 #ifdef EVDEV_SUPPORT
474 		/* register as evdev provider on first init */
475 		if (state->ks_evdev == NULL) {
476 			snprintf(phys_loc, sizeof(phys_loc), "atkbd%d", unit);
477 			evdev = evdev_alloc();
478 			evdev_set_name(evdev, "AT keyboard");
479 			evdev_set_phys(evdev, phys_loc);
480 			evdev_set_id(evdev, BUS_I8042, PS2_KEYBOARD_VENDOR,
481 			    PS2_KEYBOARD_PRODUCT, 0);
482 			evdev_set_methods(evdev, kbd, &atkbd_evdev_methods);
483 			evdev_support_event(evdev, EV_SYN);
484 			evdev_support_event(evdev, EV_KEY);
485 			evdev_support_event(evdev, EV_LED);
486 			evdev_support_event(evdev, EV_REP);
487 			evdev_support_all_known_keys(evdev);
488 			evdev_support_led(evdev, LED_NUML);
489 			evdev_support_led(evdev, LED_CAPSL);
490 			evdev_support_led(evdev, LED_SCROLLL);
491 
492 			if (evdev_register_mtx(evdev, &Giant))
493 				evdev_free(evdev);
494 			else
495 				state->ks_evdev = evdev;
496 			state->ks_evdev_state = 0;
497 		}
498 #endif
499 
500 		KBD_INIT_DONE(kbd);
501 	}
502 	if (!KBD_IS_CONFIGURED(kbd)) {
503 		if (kbd_register(kbd) < 0) {
504 			error = ENXIO;
505 			goto bad;
506 		}
507 		KBD_CONFIG_DONE(kbd);
508 	}
509 
510 	return 0;
511 bad:
512 	if (needfree) {
513 		if (state != NULL)
514 			free(state, M_DEVBUF);
515 		if (keymap != NULL)
516 			free(keymap, M_DEVBUF);
517 		if (accmap != NULL)
518 			free(accmap, M_DEVBUF);
519 		if (fkeymap != NULL)
520 			free(fkeymap, M_DEVBUF);
521 		if (kbd != NULL) {
522 			free(kbd, M_DEVBUF);
523 			*kbdp = NULL;	/* insure ref doesn't leak to caller */
524 		}
525 	}
526 	return error;
527 }
528 
529 /* finish using this keyboard */
530 static int
531 atkbd_term(keyboard_t *kbd)
532 {
533 	atkbd_state_t *state = (atkbd_state_t *)kbd->kb_data;
534 
535 	kbd_unregister(kbd);
536 	callout_drain(&state->ks_timer);
537 	return 0;
538 }
539 
540 /* keyboard interrupt routine */
541 static int
542 atkbd_intr(keyboard_t *kbd, void *arg)
543 {
544 	atkbd_state_t *state = (atkbd_state_t *)kbd->kb_data;
545 	int delay[2];
546 	int c;
547 
548 	if (!KBD_HAS_DEVICE(kbd)) {
549 		/*
550 		 * The keyboard was not detected before;
551 		 * it must have been reconnected!
552 		 */
553 		init_keyboard(state->kbdc, &kbd->kb_type, kbd->kb_config);
554 		KBD_FOUND_DEVICE(kbd);
555 		atkbd_ioctl(kbd, KDSETLED, (caddr_t)&state->ks_state);
556 		set_typematic(kbd);
557 		delay[0] = kbd->kb_delay1;
558 		delay[1] = kbd->kb_delay2;
559 		atkbd_ioctl(kbd, KDSETREPEAT, (caddr_t)delay);
560 	}
561 
562 	if (state->ks_polling)
563 		return 0;
564 
565 	if (KBD_IS_ACTIVE(kbd) && KBD_IS_BUSY(kbd)) {
566 		/* let the callback function to process the input */
567 		(*kbd->kb_callback.kc_func)(kbd, KBDIO_KEYINPUT,
568 					    kbd->kb_callback.kc_arg);
569 	} else {
570 		/* read and discard the input; no one is waiting for input */
571 		do {
572 			c = atkbd_read_char(kbd, FALSE);
573 		} while (c != NOKEY);
574 	}
575 	return 0;
576 }
577 
578 /* test the interface to the device */
579 static int
580 atkbd_test_if(keyboard_t *kbd)
581 {
582 	int error;
583 	int s;
584 
585 	error = 0;
586 	empty_both_buffers(((atkbd_state_t *)kbd->kb_data)->kbdc, 10);
587 	s = spltty();
588 	if (!test_controller(((atkbd_state_t *)kbd->kb_data)->kbdc))
589 		error = EIO;
590 	else if (test_kbd_port(((atkbd_state_t *)kbd->kb_data)->kbdc) != 0)
591 		error = EIO;
592 	splx(s);
593 
594 	return error;
595 }
596 
597 /*
598  * Enable the access to the device; until this function is called,
599  * the client cannot read from the keyboard.
600  */
601 static int
602 atkbd_enable(keyboard_t *kbd)
603 {
604 	int s;
605 
606 	s = spltty();
607 	KBD_ACTIVATE(kbd);
608 	splx(s);
609 	return 0;
610 }
611 
612 /* disallow the access to the device */
613 static int
614 atkbd_disable(keyboard_t *kbd)
615 {
616 	int s;
617 
618 	s = spltty();
619 	KBD_DEACTIVATE(kbd);
620 	splx(s);
621 	return 0;
622 }
623 
624 /* read one byte from the keyboard if it's allowed */
625 static int
626 atkbd_read(keyboard_t *kbd, int wait)
627 {
628 	int c;
629 
630 	if (wait)
631 		c = read_kbd_data(((atkbd_state_t *)kbd->kb_data)->kbdc);
632 	else
633 		c = read_kbd_data_no_wait(((atkbd_state_t *)kbd->kb_data)->kbdc);
634 	if (c != -1)
635 		++kbd->kb_count;
636 	return (KBD_IS_ACTIVE(kbd) ? c : -1);
637 }
638 
639 /* check if data is waiting */
640 static int
641 atkbd_check(keyboard_t *kbd)
642 {
643 	if (!KBD_IS_ACTIVE(kbd))
644 		return FALSE;
645 	return kbdc_data_ready(((atkbd_state_t *)kbd->kb_data)->kbdc);
646 }
647 
648 /* read char from the keyboard */
649 static u_int
650 atkbd_read_char(keyboard_t *kbd, int wait)
651 {
652 	atkbd_state_t *state;
653 	u_int action;
654 	int scancode;
655 	int keycode;
656 
657 	state = (atkbd_state_t *)kbd->kb_data;
658 next_code:
659 	/* do we have a composed char to return? */
660 	if (!(state->ks_flags & COMPOSE) && (state->ks_composed_char > 0)) {
661 		action = state->ks_composed_char;
662 		state->ks_composed_char = 0;
663 		if (action > UCHAR_MAX)
664 			return ERRKEY;
665 		return action;
666 	}
667 
668 	/* see if there is something in the keyboard port */
669 	if (wait) {
670 		do {
671 			scancode = read_kbd_data(state->kbdc);
672 		} while (scancode == -1);
673 	} else {
674 		scancode = read_kbd_data_no_wait(state->kbdc);
675 		if (scancode == -1)
676 			return NOKEY;
677 	}
678 	++kbd->kb_count;
679 
680 #if KBDIO_DEBUG >= 10
681 	printf("atkbd_read_char(): scancode:0x%x\n", scancode);
682 #endif
683 
684 #ifdef EVDEV_SUPPORT
685 	/* push evdev event */
686 	if (evdev_rcpt_mask & EVDEV_RCPT_HW_KBD && state->ks_evdev != NULL) {
687 		/* "hancha" and "han/yong" korean keys handling */
688 		if (state->ks_evdev_state == 0 &&
689 		    (scancode == 0xF1 || scancode == 0xF2)) {
690 			keycode = evdev_scancode2key(&state->ks_evdev_state,
691 				scancode & 0x7F);
692 			evdev_push_event(state->ks_evdev, EV_KEY,
693 			    (uint16_t)keycode, 1);
694 			evdev_sync(state->ks_evdev);
695 		}
696 
697 		keycode = evdev_scancode2key(&state->ks_evdev_state,
698 		    scancode);
699 
700 		if (keycode != KEY_RESERVED) {
701 			evdev_push_event(state->ks_evdev, EV_KEY,
702 			    (uint16_t)keycode, scancode & 0x80 ? 0 : 1);
703 			evdev_sync(state->ks_evdev);
704 		}
705 	}
706 #endif
707 
708 	/* return the byte as is for the K_RAW mode */
709 	if (state->ks_mode == K_RAW)
710 		return scancode;
711 
712 	/* translate the scan code into a keycode */
713 	keycode = scancode & 0x7F;
714 	switch (state->ks_prefix) {
715 	case 0x00:	/* normal scancode */
716 		switch(scancode) {
717 		case 0xB8:	/* left alt (compose key) released */
718 			if (state->ks_flags & COMPOSE) {
719 				state->ks_flags &= ~COMPOSE;
720 				if (state->ks_composed_char > UCHAR_MAX)
721 					state->ks_composed_char = 0;
722 			}
723 			break;
724 		case 0x38:	/* left alt (compose key) pressed */
725 			if (!(state->ks_flags & COMPOSE)) {
726 				state->ks_flags |= COMPOSE;
727 				state->ks_composed_char = 0;
728 			}
729 			break;
730 		case 0xE0:
731 		case 0xE1:
732 			state->ks_prefix = scancode;
733 			goto next_code;
734 		}
735 		break;
736 	case 0xE0:		/* 0xE0 prefix */
737 		state->ks_prefix = 0;
738 		switch (keycode) {
739 		case 0x1C:	/* right enter key */
740 			keycode = 0x59;
741 			break;
742 		case 0x1D:	/* right ctrl key */
743 			keycode = 0x5A;
744 			break;
745 		case 0x35:	/* keypad divide key */
746 			keycode = 0x5B;
747 			break;
748 		case 0x37:	/* print scrn key */
749 			keycode = 0x5C;
750 			break;
751 		case 0x38:	/* right alt key (alt gr) */
752 			keycode = 0x5D;
753 			break;
754 		case 0x46:	/* ctrl-pause/break on AT 101 (see below) */
755 			keycode = 0x68;
756 			break;
757 		case 0x47:	/* grey home key */
758 			keycode = 0x5E;
759 			break;
760 		case 0x48:	/* grey up arrow key */
761 			keycode = 0x5F;
762 			break;
763 		case 0x49:	/* grey page up key */
764 			keycode = 0x60;
765 			break;
766 		case 0x4B:	/* grey left arrow key */
767 			keycode = 0x61;
768 			break;
769 		case 0x4D:	/* grey right arrow key */
770 			keycode = 0x62;
771 			break;
772 		case 0x4F:	/* grey end key */
773 			keycode = 0x63;
774 			break;
775 		case 0x50:	/* grey down arrow key */
776 			keycode = 0x64;
777 			break;
778 		case 0x51:	/* grey page down key */
779 			keycode = 0x65;
780 			break;
781 		case 0x52:	/* grey insert key */
782 			keycode = 0x66;
783 			break;
784 		case 0x53:	/* grey delete key */
785 			keycode = 0x67;
786 			break;
787 			/* the following 3 are only used on the MS "Natural" keyboard */
788 		case 0x5b:	/* left Window key */
789 			keycode = 0x69;
790 			break;
791 		case 0x5c:	/* right Window key */
792 			keycode = 0x6a;
793 			break;
794 		case 0x5d:	/* menu key */
795 			keycode = 0x6b;
796 			break;
797 		case 0x5e:	/* power key */
798 			keycode = 0x6d;
799 			break;
800 		case 0x5f:	/* sleep key */
801 			keycode = 0x6e;
802 			break;
803 		case 0x63:	/* wake key */
804 			keycode = 0x6f;
805 			break;
806 		default:	/* ignore everything else */
807 			goto next_code;
808 		}
809 		break;
810    	case 0xE1:	/* 0xE1 prefix */
811 		/*
812 		 * The pause/break key on the 101 keyboard produces:
813 		 * E1-1D-45 E1-9D-C5
814 		 * Ctrl-pause/break produces:
815 		 * E0-46 E0-C6 (See above.)
816 		 */
817 		state->ks_prefix = 0;
818 		if (keycode == 0x1D)
819 			state->ks_prefix = 0x1D;
820 		goto next_code;
821 		/* NOT REACHED */
822    	case 0x1D:	/* pause / break */
823 		state->ks_prefix = 0;
824 		if (keycode != 0x45)
825 			goto next_code;
826 		keycode = 0x68;
827 		break;
828 	}
829 
830 	if (kbd->kb_type == KB_84) {
831 		switch (keycode) {
832 		case 0x37:	/* *(numpad)/print screen */
833 			if (state->ks_flags & SHIFTS)
834 				keycode = 0x5c;	/* print screen */
835 			break;
836 		case 0x45:	/* num lock/pause */
837 			if (state->ks_flags & CTLS)
838 				keycode = 0x68;	/* pause */
839 			break;
840 		case 0x46:	/* scroll lock/break */
841 			if (state->ks_flags & CTLS)
842 				keycode = 0x6c;	/* break */
843 			break;
844 		}
845 	} else if (kbd->kb_type == KB_101) {
846 		switch (keycode) {
847 		case 0x5c:	/* print screen */
848 			if (state->ks_flags & ALTS)
849 				keycode = 0x54;	/* sysrq */
850 			break;
851 		case 0x68:	/* pause/break */
852 			if (state->ks_flags & CTLS)
853 				keycode = 0x6c;	/* break */
854 			break;
855 		}
856 	}
857 
858 	/* return the key code in the K_CODE mode */
859 	if (state->ks_mode == K_CODE)
860 		return (keycode | (scancode & 0x80));
861 
862 	/* compose a character code */
863 	if (state->ks_flags & COMPOSE) {
864 		switch (keycode | (scancode & 0x80)) {
865 		/* key pressed, process it */
866 		case 0x47: case 0x48: case 0x49:	/* keypad 7,8,9 */
867 			state->ks_composed_char *= 10;
868 			state->ks_composed_char += keycode - 0x40;
869 			if (state->ks_composed_char > UCHAR_MAX)
870 				return ERRKEY;
871 			goto next_code;
872 		case 0x4B: case 0x4C: case 0x4D:	/* keypad 4,5,6 */
873 			state->ks_composed_char *= 10;
874 			state->ks_composed_char += keycode - 0x47;
875 			if (state->ks_composed_char > UCHAR_MAX)
876 				return ERRKEY;
877 			goto next_code;
878 		case 0x4F: case 0x50: case 0x51:	/* keypad 1,2,3 */
879 			state->ks_composed_char *= 10;
880 			state->ks_composed_char += keycode - 0x4E;
881 			if (state->ks_composed_char > UCHAR_MAX)
882 				return ERRKEY;
883 			goto next_code;
884 		case 0x52:				/* keypad 0 */
885 			state->ks_composed_char *= 10;
886 			if (state->ks_composed_char > UCHAR_MAX)
887 				return ERRKEY;
888 			goto next_code;
889 
890 		/* key released, no interest here */
891 		case 0xC7: case 0xC8: case 0xC9:	/* keypad 7,8,9 */
892 		case 0xCB: case 0xCC: case 0xCD:	/* keypad 4,5,6 */
893 		case 0xCF: case 0xD0: case 0xD1:	/* keypad 1,2,3 */
894 		case 0xD2:				/* keypad 0 */
895 			goto next_code;
896 
897 		case 0x38:				/* left alt key */
898 			break;
899 
900 		default:
901 			if (state->ks_composed_char > 0) {
902 				state->ks_flags &= ~COMPOSE;
903 				state->ks_composed_char = 0;
904 				return ERRKEY;
905 			}
906 			break;
907 		}
908 	}
909 
910 	/* keycode to key action */
911 	action = genkbd_keyaction(kbd, keycode, scancode & 0x80,
912 				  &state->ks_state, &state->ks_accents);
913 	if (action == NOKEY)
914 		goto next_code;
915 	else
916 		return action;
917 }
918 
919 /* check if char is waiting */
920 static int
921 atkbd_check_char(keyboard_t *kbd)
922 {
923 	atkbd_state_t *state;
924 
925 	if (!KBD_IS_ACTIVE(kbd))
926 		return FALSE;
927 	state = (atkbd_state_t *)kbd->kb_data;
928 	if (!(state->ks_flags & COMPOSE) && (state->ks_composed_char > 0))
929 		return TRUE;
930 	return kbdc_data_ready(state->kbdc);
931 }
932 
933 /* some useful control functions */
934 static int
935 atkbd_ioctl(keyboard_t *kbd, u_long cmd, caddr_t arg)
936 {
937 	/* translate LED_XXX bits into the device specific bits */
938 	static u_char ledmap[8] = {
939 		0, 4, 2, 6, 1, 5, 3, 7,
940 	};
941 	atkbd_state_t *state = kbd->kb_data;
942 	int error;
943 	int s;
944 	int i;
945 #if defined(COMPAT_FREEBSD6) || defined(COMPAT_FREEBSD5) || \
946     defined(COMPAT_FREEBSD4) || defined(COMPAT_43)
947 	int ival;
948 #endif
949 
950 	s = spltty();
951 	switch (cmd) {
952 	case KDGKBMODE:		/* get keyboard mode */
953 		*(int *)arg = state->ks_mode;
954 		break;
955 #if defined(COMPAT_FREEBSD6) || defined(COMPAT_FREEBSD5) || \
956     defined(COMPAT_FREEBSD4) || defined(COMPAT_43)
957 	case _IO('K', 7):
958 		ival = IOCPARM_IVAL(arg);
959 		arg = (caddr_t)&ival;
960 		/* FALLTHROUGH */
961 #endif
962 	case KDSKBMODE:		/* set keyboard mode */
963 		switch (*(int *)arg) {
964 		case K_XLATE:
965 			if (state->ks_mode != K_XLATE) {
966 				/* make lock key state and LED state match */
967 				state->ks_state &= ~LOCK_MASK;
968 				state->ks_state |= KBD_LED_VAL(kbd);
969 			}
970 			/* FALLTHROUGH */
971 		case K_RAW:
972 		case K_CODE:
973 			if (state->ks_mode != *(int *)arg) {
974 				atkbd_clear_state(kbd);
975 				state->ks_mode = *(int *)arg;
976 			}
977 			break;
978 		default:
979 			splx(s);
980 			return EINVAL;
981 		}
982 		break;
983 
984 	case KDGETLED:		/* get keyboard LED */
985 		*(int *)arg = KBD_LED_VAL(kbd);
986 		break;
987 #if defined(COMPAT_FREEBSD6) || defined(COMPAT_FREEBSD5) || \
988     defined(COMPAT_FREEBSD4) || defined(COMPAT_43)
989 	case _IO('K', 66):
990 		ival = IOCPARM_IVAL(arg);
991 		arg = (caddr_t)&ival;
992 		/* FALLTHROUGH */
993 #endif
994 	case KDSETLED:		/* set keyboard LED */
995 		/* NOTE: lock key state in ks_state won't be changed */
996 		if (*(int *)arg & ~LOCK_MASK) {
997 			splx(s);
998 			return EINVAL;
999 		}
1000 		i = *(int *)arg;
1001 		/* replace CAPS LED with ALTGR LED for ALTGR keyboards */
1002 		if (state->ks_mode == K_XLATE &&
1003 		    kbd->kb_keymap->n_keys > ALTGR_OFFSET) {
1004 			if (i & ALKED)
1005 				i |= CLKED;
1006 			else
1007 				i &= ~CLKED;
1008 		}
1009 		if (KBD_HAS_DEVICE(kbd)) {
1010 			error = write_kbd(state->kbdc, KBDC_SET_LEDS,
1011 					  ledmap[i & LED_MASK]);
1012 			if (error) {
1013 				splx(s);
1014 				return error;
1015 			}
1016 		}
1017 #ifdef EVDEV_SUPPORT
1018 		/* push LED states to evdev */
1019 		if (state->ks_evdev != NULL &&
1020 		    evdev_rcpt_mask & EVDEV_RCPT_HW_KBD)
1021 			evdev_push_leds(state->ks_evdev, *(int *)arg);
1022 #endif
1023 		KBD_LED_VAL(kbd) = *(int *)arg;
1024 		break;
1025 
1026 	case KDGKBSTATE:	/* get lock key state */
1027 		*(int *)arg = state->ks_state & LOCK_MASK;
1028 		break;
1029 #if defined(COMPAT_FREEBSD6) || defined(COMPAT_FREEBSD5) || \
1030     defined(COMPAT_FREEBSD4) || defined(COMPAT_43)
1031 	case _IO('K', 20):
1032 		ival = IOCPARM_IVAL(arg);
1033 		arg = (caddr_t)&ival;
1034 		/* FALLTHROUGH */
1035 #endif
1036 	case KDSKBSTATE:	/* set lock key state */
1037 		if (*(int *)arg & ~LOCK_MASK) {
1038 			splx(s);
1039 			return EINVAL;
1040 		}
1041 		state->ks_state &= ~LOCK_MASK;
1042 		state->ks_state |= *(int *)arg;
1043 		splx(s);
1044 		/* set LEDs and quit */
1045 		return atkbd_ioctl(kbd, KDSETLED, arg);
1046 
1047 	case KDSETREPEAT:	/* set keyboard repeat rate (new interface) */
1048 		splx(s);
1049 		if (!KBD_HAS_DEVICE(kbd))
1050 			return 0;
1051 		i = typematic(((int *)arg)[0], ((int *)arg)[1]);
1052 		error = write_kbd(state->kbdc, KBDC_SET_TYPEMATIC, i);
1053 		if (error == 0) {
1054 			kbd->kb_delay1 = typematic_delay(i);
1055 			kbd->kb_delay2 = typematic_rate(i);
1056 #ifdef EVDEV_SUPPORT
1057 			if (state->ks_evdev != NULL &&
1058 			    evdev_rcpt_mask & EVDEV_RCPT_HW_KBD)
1059 				evdev_push_repeats(state->ks_evdev, kbd);
1060 #endif
1061 		}
1062 		return error;
1063 
1064 #if defined(COMPAT_FREEBSD6) || defined(COMPAT_FREEBSD5) || \
1065     defined(COMPAT_FREEBSD4) || defined(COMPAT_43)
1066 	case _IO('K', 67):
1067 		ival = IOCPARM_IVAL(arg);
1068 		arg = (caddr_t)&ival;
1069 		/* FALLTHROUGH */
1070 #endif
1071 	case KDSETRAD:		/* set keyboard repeat rate (old interface) */
1072 		splx(s);
1073 		if (!KBD_HAS_DEVICE(kbd))
1074 			return 0;
1075 		error = write_kbd(state->kbdc, KBDC_SET_TYPEMATIC, *(int *)arg);
1076 		if (error == 0) {
1077 			kbd->kb_delay1 = typematic_delay(*(int *)arg);
1078 			kbd->kb_delay2 = typematic_rate(*(int *)arg);
1079 #ifdef EVDEV_SUPPORT
1080 			if (state->ks_evdev != NULL &&
1081 			    evdev_rcpt_mask & EVDEV_RCPT_HW_KBD)
1082 				evdev_push_repeats(state->ks_evdev, kbd);
1083 #endif
1084 		}
1085 		return error;
1086 
1087 	case PIO_KEYMAP:	/* set keyboard translation table */
1088 	case OPIO_KEYMAP:	/* set keyboard translation table (compat) */
1089 	case PIO_KEYMAPENT:	/* set keyboard translation table entry */
1090 	case PIO_DEADKEYMAP:	/* set accent key translation table */
1091 		state->ks_accents = 0;
1092 		/* FALLTHROUGH */
1093 	default:
1094 		splx(s);
1095 		return genkbd_commonioctl(kbd, cmd, arg);
1096 	}
1097 
1098 	splx(s);
1099 	return 0;
1100 }
1101 
1102 /* lock the access to the keyboard */
1103 static int
1104 atkbd_lock(keyboard_t *kbd, int lock)
1105 {
1106 	return kbdc_lock(((atkbd_state_t *)kbd->kb_data)->kbdc, lock);
1107 }
1108 
1109 /* clear the internal state of the keyboard */
1110 static void
1111 atkbd_clear_state(keyboard_t *kbd)
1112 {
1113 	atkbd_state_t *state;
1114 
1115 	state = (atkbd_state_t *)kbd->kb_data;
1116 	state->ks_flags = 0;
1117 	state->ks_polling = 0;
1118 	state->ks_state &= LOCK_MASK;	/* preserve locking key state */
1119 	state->ks_accents = 0;
1120 	state->ks_composed_char = 0;
1121 #if 0
1122 	state->ks_prefix = 0; /* XXX */
1123 #endif
1124 }
1125 
1126 /* save the internal state */
1127 static int
1128 atkbd_get_state(keyboard_t *kbd, void *buf, size_t len)
1129 {
1130 	if (len == 0)
1131 		return sizeof(atkbd_state_t);
1132 	if (len < sizeof(atkbd_state_t))
1133 		return -1;
1134 	bcopy(kbd->kb_data, buf, sizeof(atkbd_state_t));
1135 	return 0;
1136 }
1137 
1138 /* set the internal state */
1139 static int
1140 atkbd_set_state(keyboard_t *kbd, void *buf, size_t len)
1141 {
1142 	if (len < sizeof(atkbd_state_t))
1143 		return ENOMEM;
1144 	if (((atkbd_state_t *)kbd->kb_data)->kbdc
1145 		!= ((atkbd_state_t *)buf)->kbdc)
1146 		return ENOMEM;
1147 	bcopy(buf, kbd->kb_data, sizeof(atkbd_state_t));
1148 	return 0;
1149 }
1150 
1151 static int
1152 atkbd_poll(keyboard_t *kbd, int on)
1153 {
1154 	atkbd_state_t *state;
1155 	int s;
1156 
1157 	state = (atkbd_state_t *)kbd->kb_data;
1158 	s = spltty();
1159 	if (on)
1160 		++state->ks_polling;
1161 	else
1162 		--state->ks_polling;
1163 	splx(s);
1164 	return 0;
1165 }
1166 
1167 static int
1168 atkbd_reset(KBDC kbdc, int flags, int c)
1169 {
1170 	/* reset keyboard hardware */
1171 	if (!(flags & KB_CONF_NO_RESET) && !reset_kbd(kbdc)) {
1172 		/*
1173 		 * KEYBOARD ERROR
1174 		 * Keyboard reset may fail either because the keyboard
1175 		 * doen't exist, or because the keyboard doesn't pass
1176 		 * the self-test, or the keyboard controller on the
1177 		 * motherboard and the keyboard somehow fail to shake hands.
1178 		 * It is just possible, particularly in the last case,
1179 		 * that the keyboard controller may be left in a hung state.
1180 		 * test_controller() and test_kbd_port() appear to bring
1181 		 * the keyboard controller back (I don't know why and how,
1182 		 * though.)
1183 		 */
1184 		empty_both_buffers(kbdc, 10);
1185 		test_controller(kbdc);
1186 		test_kbd_port(kbdc);
1187 		/*
1188 		 * We could disable the keyboard port and interrupt... but,
1189 		 * the keyboard may still exist (see above).
1190 		 */
1191 		set_controller_command_byte(kbdc,
1192 		    ALLOW_DISABLE_KBD(kbdc) ? 0xff : KBD_KBD_CONTROL_BITS, c);
1193 		if (bootverbose)
1194 			printf("atkbd: failed to reset the keyboard.\n");
1195 		return (EIO);
1196 	}
1197 	return (0);
1198 }
1199 
1200 #ifdef EVDEV_SUPPORT
1201 static void
1202 atkbd_ev_event(struct evdev_dev *evdev, uint16_t type, uint16_t code,
1203     int32_t value)
1204 {
1205 	keyboard_t *kbd = evdev_get_softc(evdev);
1206 
1207 	if (evdev_rcpt_mask & EVDEV_RCPT_HW_KBD &&
1208 	    (type == EV_LED || type == EV_REP)) {
1209 		mtx_lock(&Giant);
1210 		kbd_ev_event(kbd, type, code, value);
1211 		mtx_unlock(&Giant);
1212 	}
1213 }
1214 #endif
1215 
1216 /* local functions */
1217 
1218 static int
1219 set_typematic(keyboard_t *kbd)
1220 {
1221 	int val, error;
1222 	atkbd_state_t *state = kbd->kb_data;
1223 
1224 	val = typematic(DEFAULT_DELAY, DEFAULT_RATE);
1225 	error = write_kbd(state->kbdc, KBDC_SET_TYPEMATIC, val);
1226 	if (error == 0) {
1227 		kbd->kb_delay1 = typematic_delay(val);
1228 		kbd->kb_delay2 = typematic_rate(val);
1229 	}
1230 
1231 	return (error);
1232 }
1233 
1234 static int
1235 setup_kbd_port(KBDC kbdc, int port, int intr)
1236 {
1237 	if (!set_controller_command_byte(kbdc,
1238 		KBD_KBD_CONTROL_BITS,
1239 		((port) ? KBD_ENABLE_KBD_PORT : KBD_DISABLE_KBD_PORT)
1240 		    | ((intr) ? KBD_ENABLE_KBD_INT : KBD_DISABLE_KBD_INT)))
1241 		return 1;
1242 	return 0;
1243 }
1244 
1245 static int
1246 get_kbd_echo(KBDC kbdc)
1247 {
1248 	/* enable the keyboard port, but disable the keyboard intr. */
1249 	if (setup_kbd_port(kbdc, TRUE, FALSE))
1250 		/* CONTROLLER ERROR: there is very little we can do... */
1251 		return ENXIO;
1252 
1253 	/* see if something is present */
1254 	write_kbd_command(kbdc, KBDC_ECHO);
1255 	if (read_kbd_data(kbdc) != KBD_ECHO) {
1256 		empty_both_buffers(kbdc, 10);
1257 		test_controller(kbdc);
1258 		test_kbd_port(kbdc);
1259 		return ENXIO;
1260 	}
1261 
1262 	/* enable the keyboard port and intr. */
1263 	if (setup_kbd_port(kbdc, TRUE, TRUE)) {
1264 		/*
1265 		 * CONTROLLER ERROR
1266 		 * This is serious; the keyboard intr is left disabled!
1267 		 */
1268 		return ENXIO;
1269 	}
1270 
1271 	return 0;
1272 }
1273 
1274 static int
1275 probe_keyboard(KBDC kbdc, int flags)
1276 {
1277 	/*
1278 	 * Don't try to print anything in this function.  The low-level
1279 	 * console may not have been initialized yet...
1280 	 */
1281 	int err;
1282 	int c;
1283 	int m;
1284 
1285 	if (!kbdc_lock(kbdc, TRUE)) {
1286 		/* driver error? */
1287 		return ENXIO;
1288 	}
1289 
1290 	/* temporarily block data transmission from the keyboard */
1291 	write_controller_command(kbdc, KBDC_DISABLE_KBD_PORT);
1292 
1293 	/* flush any noise in the buffer */
1294 	empty_both_buffers(kbdc, 100);
1295 
1296 	/* save the current keyboard controller command byte */
1297 	m = kbdc_get_device_mask(kbdc) & ~KBD_KBD_CONTROL_BITS;
1298 	c = get_controller_command_byte(kbdc);
1299 	if (c == -1) {
1300 		/* CONTROLLER ERROR */
1301 		kbdc_set_device_mask(kbdc, m);
1302 		kbdc_lock(kbdc, FALSE);
1303 		return ENXIO;
1304 	}
1305 
1306 	/*
1307 	 * The keyboard may have been screwed up by the boot block.
1308 	 * We may just be able to recover from error by testing the controller
1309 	 * and the keyboard port. The controller command byte needs to be
1310 	 * saved before this recovery operation, as some controllers seem
1311 	 * to set the command byte to particular values.
1312 	 */
1313 	test_controller(kbdc);
1314 	if (!(flags & KB_CONF_NO_PROBE_TEST))
1315 		test_kbd_port(kbdc);
1316 
1317 	err = get_kbd_echo(kbdc);
1318 
1319 	/*
1320 	 * Even if the keyboard doesn't seem to be present (err != 0),
1321 	 * we shall enable the keyboard port and interrupt so that
1322 	 * the driver will be operable when the keyboard is attached
1323 	 * to the system later.  It is NOT recommended to hot-plug
1324 	 * the AT keyboard, but many people do so...
1325 	 */
1326 	kbdc_set_device_mask(kbdc, m | KBD_KBD_CONTROL_BITS);
1327 	setup_kbd_port(kbdc, TRUE, TRUE);
1328 #if 0
1329 	if (err == 0) {
1330 		kbdc_set_device_mask(kbdc, m | KBD_KBD_CONTROL_BITS);
1331 	} else {
1332 		/* try to restore the command byte as before */
1333 		set_controller_command_byte(kbdc,
1334 		    ALLOW_DISABLE_KBD(kbdc) ? 0xff : KBD_KBD_CONTROL_BITS, c);
1335 		kbdc_set_device_mask(kbdc, m);
1336 	}
1337 #endif
1338 
1339 	kbdc_lock(kbdc, FALSE);
1340 	return (HAS_QUIRK(kbdc, KBDC_QUIRK_IGNORE_PROBE_RESULT) ? 0 : err);
1341 }
1342 
1343 static int
1344 init_keyboard(KBDC kbdc, int *type, int flags)
1345 {
1346 	int codeset;
1347 	int id;
1348 	int c;
1349 
1350 	if (!kbdc_lock(kbdc, TRUE)) {
1351 		/* driver error? */
1352 		return EIO;
1353 	}
1354 
1355 	/* temporarily block data transmission from the keyboard */
1356 	write_controller_command(kbdc, KBDC_DISABLE_KBD_PORT);
1357 
1358 	/* save the current controller command byte */
1359 	empty_both_buffers(kbdc, 200);
1360 	c = get_controller_command_byte(kbdc);
1361 	if (c == -1) {
1362 		/* CONTROLLER ERROR */
1363 		kbdc_lock(kbdc, FALSE);
1364 		printf("atkbd: unable to get the current command byte value.\n");
1365 		return EIO;
1366 	}
1367 	if (bootverbose)
1368 		printf("atkbd: the current kbd controller command byte %04x\n",
1369 		   c);
1370 #if 0
1371 	/* override the keyboard lock switch */
1372 	c |= KBD_OVERRIDE_KBD_LOCK;
1373 #endif
1374 
1375 	/* enable the keyboard port, but disable the keyboard intr. */
1376 	if (setup_kbd_port(kbdc, TRUE, FALSE)) {
1377 		/* CONTROLLER ERROR: there is very little we can do... */
1378 		printf("atkbd: unable to set the command byte.\n");
1379 		kbdc_lock(kbdc, FALSE);
1380 		return EIO;
1381 	}
1382 
1383 	if (HAS_QUIRK(kbdc, KBDC_QUIRK_RESET_AFTER_PROBE) &&
1384 	    atkbd_reset(kbdc, flags, c)) {
1385 		kbdc_lock(kbdc, FALSE);
1386 		return EIO;
1387 	}
1388 
1389 	/*
1390 	 * Check if we have an XT keyboard before we attempt to reset it.
1391 	 * The procedure assumes that the keyboard and the controller have
1392 	 * been set up properly by BIOS and have not been messed up
1393 	 * during the boot process.
1394 	 */
1395 	codeset = -1;
1396 	if (flags & KB_CONF_ALT_SCANCODESET)
1397 		/* the user says there is a XT keyboard */
1398 		codeset = 1;
1399 #ifdef KBD_DETECT_XT_KEYBOARD
1400 	else if ((c & KBD_TRANSLATION) == 0) {
1401 		/* SET_SCANCODE_SET is not always supported; ignore error */
1402 		if (send_kbd_command_and_data(kbdc, KBDC_SET_SCANCODE_SET, 0)
1403 			== KBD_ACK)
1404 			codeset = read_kbd_data(kbdc);
1405 	}
1406 	if (bootverbose)
1407 		printf("atkbd: scancode set %d\n", codeset);
1408 #endif /* KBD_DETECT_XT_KEYBOARD */
1409 
1410 	*type = KB_OTHER;
1411 	id = get_kbd_id(kbdc);
1412 	switch(id) {
1413 	case 0x41ab:	/* 101/102/... Enhanced */
1414 	case 0x83ab:	/* ditto */
1415 	case 0x54ab:	/* SpaceSaver */
1416 	case 0x84ab:	/* ditto */
1417 #if 0
1418 	case 0x90ab:	/* 'G' */
1419 	case 0x91ab:	/* 'P' */
1420 	case 0x92ab:	/* 'A' */
1421 #endif
1422 		*type = KB_101;
1423 		break;
1424 	case -1:	/* AT 84 keyboard doesn't return ID */
1425 		*type = KB_84;
1426 		break;
1427 	default:
1428 		break;
1429 	}
1430 	if (bootverbose)
1431 		printf("atkbd: keyboard ID 0x%x (%d)\n", id, *type);
1432 
1433 	if (!HAS_QUIRK(kbdc, KBDC_QUIRK_RESET_AFTER_PROBE) &&
1434 	    atkbd_reset(kbdc, flags, c)) {
1435 		kbdc_lock(kbdc, FALSE);
1436 		return EIO;
1437 	}
1438 
1439 	/*
1440 	 * Allow us to set the XT_KEYBD flag so that keyboards
1441 	 * such as those on the IBM ThinkPad laptop computers can be used
1442 	 * with the standard console driver.
1443 	 */
1444 	if (codeset == 1) {
1445 		if (send_kbd_command_and_data(kbdc,
1446 			KBDC_SET_SCANCODE_SET, codeset) == KBD_ACK) {
1447 			/* XT kbd doesn't need scan code translation */
1448 			c &= ~KBD_TRANSLATION;
1449 		} else {
1450 			/*
1451 			 * KEYBOARD ERROR
1452 			 * The XT kbd isn't usable unless the proper scan
1453 			 * code set is selected.
1454 			 */
1455 			set_controller_command_byte(kbdc, ALLOW_DISABLE_KBD(kbdc)
1456 			    ? 0xff : KBD_KBD_CONTROL_BITS, c);
1457 			kbdc_lock(kbdc, FALSE);
1458 			printf("atkbd: unable to set the XT keyboard mode.\n");
1459 			return EIO;
1460 		}
1461 	}
1462 
1463 	/*
1464 	 * Some keyboards require a SETLEDS command to be sent after
1465 	 * the reset command before they will send keystrokes to us
1466 	 */
1467 	if (HAS_QUIRK(kbdc, KBDC_QUIRK_SETLEDS_ON_INIT) &&
1468 	    send_kbd_command_and_data(kbdc, KBDC_SET_LEDS, 0) != KBD_ACK) {
1469 		printf("atkbd: setleds failed\n");
1470 	}
1471 	if (!ALLOW_DISABLE_KBD(kbdc))
1472 	    send_kbd_command(kbdc, KBDC_ENABLE_KBD);
1473 
1474 	/* enable the keyboard port and intr. */
1475 	if (!set_controller_command_byte(kbdc,
1476 		KBD_KBD_CONTROL_BITS | KBD_TRANSLATION | KBD_OVERRIDE_KBD_LOCK,
1477 		(c & (KBD_TRANSLATION | KBD_OVERRIDE_KBD_LOCK))
1478 		    | KBD_ENABLE_KBD_PORT | KBD_ENABLE_KBD_INT)) {
1479 		/*
1480 		 * CONTROLLER ERROR
1481 		 * This is serious; we are left with the disabled
1482 		 * keyboard intr.
1483 		 */
1484 		set_controller_command_byte(kbdc, ALLOW_DISABLE_KBD(kbdc)
1485 		    ? 0xff : (KBD_KBD_CONTROL_BITS | KBD_TRANSLATION |
1486 			KBD_OVERRIDE_KBD_LOCK), c);
1487 		kbdc_lock(kbdc, FALSE);
1488 		printf("atkbd: unable to enable the keyboard port and intr.\n");
1489 		return EIO;
1490 	}
1491 
1492 	kbdc_lock(kbdc, FALSE);
1493 	return 0;
1494 }
1495 
1496 static int
1497 write_kbd(KBDC kbdc, int command, int data)
1498 {
1499 	int s;
1500 
1501 	/* prevent the timeout routine from polling the keyboard */
1502 	if (!kbdc_lock(kbdc, TRUE))
1503 		return EBUSY;
1504 
1505 	/* disable the keyboard and mouse interrupt */
1506 	s = spltty();
1507 #if 0
1508 	c = get_controller_command_byte(kbdc);
1509 	if ((c == -1)
1510 	    || !set_controller_command_byte(kbdc,
1511 		kbdc_get_device_mask(kbdc),
1512 		KBD_DISABLE_KBD_PORT | KBD_DISABLE_KBD_INT
1513 		| KBD_DISABLE_AUX_PORT | KBD_DISABLE_AUX_INT)) {
1514 		/* CONTROLLER ERROR */
1515 		kbdc_lock(kbdc, FALSE);
1516 		splx(s);
1517 		return EIO;
1518 	}
1519 	/*
1520 	 * Now that the keyboard controller is told not to generate
1521 	 * the keyboard and mouse interrupts, call `splx()' to allow
1522 	 * the other tty interrupts. The clock interrupt may also occur,
1523 	 * but the timeout routine (`scrn_timer()') will be blocked
1524 	 * by the lock flag set via `kbdc_lock()'
1525 	 */
1526 	splx(s);
1527 #endif
1528 	if (send_kbd_command_and_data(kbdc, command, data) != KBD_ACK)
1529 		send_kbd_command(kbdc, KBDC_ENABLE_KBD);
1530 #if 0
1531 	/* restore the interrupts */
1532 	if (!set_controller_command_byte(kbdc, kbdc_get_device_mask(kbdc),
1533 	    c & (KBD_KBD_CONTROL_BITS | KBD_AUX_CONTROL_BITS))) {
1534 		/* CONTROLLER ERROR */
1535 	}
1536 #else
1537 	splx(s);
1538 #endif
1539 	kbdc_lock(kbdc, FALSE);
1540 
1541 	return 0;
1542 }
1543 
1544 static int
1545 get_kbd_id(KBDC kbdc)
1546 {
1547 	int id1, id2;
1548 
1549 	empty_both_buffers(kbdc, 10);
1550 	id1 = id2 = -1;
1551 	if (send_kbd_command(kbdc, KBDC_SEND_DEV_ID) != KBD_ACK)
1552 		return -1;
1553 
1554 	DELAY(10000); 	/* 10 msec delay */
1555 	id1 = read_kbd_data(kbdc);
1556 	if (id1 != -1)
1557 		id2 = read_kbd_data(kbdc);
1558 
1559 	if ((id1 == -1) || (id2 == -1)) {
1560 		empty_both_buffers(kbdc, 10);
1561 		test_controller(kbdc);
1562 		test_kbd_port(kbdc);
1563 		return -1;
1564 	}
1565 	return ((id2 << 8) | id1);
1566 }
1567 
1568 static int delays[] = { 250, 500, 750, 1000 };
1569 static int rates[] = {  34,  38,  42,  46,  50,  55,  59,  63,
1570 			68,  76,  84,  92, 100, 110, 118, 126,
1571 		       136, 152, 168, 184, 200, 220, 236, 252,
1572 		       272, 304, 336, 368, 400, 440, 472, 504 };
1573 
1574 static int
1575 typematic_delay(int i)
1576 {
1577 	return delays[(i >> 5) & 3];
1578 }
1579 
1580 static int
1581 typematic_rate(int i)
1582 {
1583 	return rates[i & 0x1f];
1584 }
1585 
1586 static int
1587 typematic(int delay, int rate)
1588 {
1589 	int value;
1590 	int i;
1591 
1592 	for (i = nitems(delays) - 1; i > 0; --i) {
1593 		if (delay >= delays[i])
1594 			break;
1595 	}
1596 	value = i << 5;
1597 	for (i = nitems(rates) - 1; i > 0; --i) {
1598 		if (rate >= rates[i])
1599 			break;
1600 	}
1601 	value |= i;
1602 	return value;
1603 }
1604