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/kbd.c,v 1.17.2.2 2001/07/30 16:46:43 yokota Exp $
31 * Generic keyboard driver.
33 * Interrupt note: keyboards use clist functions and since usb keyboard
34 * interrupts are not protected by spltty(), we must use a critical section
35 * to protect against corruption.
36 * XXX: this keyboard driver doesn't use clist functions anymore!
38 * MPSAFE NOTE: all keyboards could easily be put under a different global token.
43 #include <sys/param.h>
44 #include <sys/systm.h>
45 #include <sys/kernel.h>
46 #include <sys/malloc.h>
50 #include <sys/event.h>
51 #include <sys/vnode.h>
53 #include <sys/thread.h>
54 #include <sys/thread2.h>
56 #include <machine/console.h>
61 #define lwkt_gettoken(x)
62 #define lwkt_reltoken(x)
65 #define KBD_INDEX(dev) minor(dev)
71 int gkb_flags; /* flag/status bits */
72 #define KB_ASLEEP (1 << 0)
73 struct kqinfo gkb_rkq;
74 char gkb_q[KB_QSIZE]; /* input queue */
75 unsigned int gkb_q_start;
76 unsigned int gkb_q_length;
79 typedef struct genkbd_softc *genkbd_softc_t;
81 static SLIST_HEAD(, keyboard_driver) keyboard_drivers =
82 SLIST_HEAD_INITIALIZER(keyboard_drivers);
84 SET_DECLARE(kbddriver_set, const keyboard_driver_t);
89 * We need at least one entry each in order to initialize a keyboard
90 * for the kernel console. The arrays will be increased dynamically
94 static int keyboards = 1;
95 static keyboard_t *kbd_ini;
96 static keyboard_t **keyboard = &kbd_ini;
97 static keyboard_switch_t *kbdsw_ini;
98 keyboard_switch_t **kbdsw = &kbdsw_ini;
100 #define ARRAY_DELTA 4
103 kbd_realloc_array(void)
105 keyboard_t **new_kbd;
106 keyboard_switch_t **new_kbdsw;
109 lwkt_gettoken(&tty_token);
110 newsize = ((keyboards + ARRAY_DELTA)/ARRAY_DELTA)*ARRAY_DELTA;
111 new_kbd = kmalloc(sizeof(*new_kbd) * newsize, M_DEVBUF,
113 new_kbdsw = kmalloc(sizeof(*new_kbdsw) * newsize, M_DEVBUF,
115 bcopy(keyboard, new_kbd, sizeof(*keyboard)*keyboards);
116 bcopy(kbdsw, new_kbdsw, sizeof(*kbdsw)*keyboards);
119 kfree(keyboard, M_DEVBUF);
120 kfree(kbdsw, M_DEVBUF);
128 kprintf("kbd: new array size %d\n", keyboards);
130 lwkt_reltoken(&tty_token);
135 * Low-level keyboard driver functions.
137 * Keyboard subdrivers, such as the AT keyboard driver and the USB keyboard
138 * driver, call these functions to initialize the keyboard_t structure
139 * and register it to the virtual keyboard driver `kbd'.
141 * The reinit call is made when a driver has partially detached a keyboard
142 * but does not unregistered it, then wishes to reinitialize it later on.
143 * This is how the USB keyboard driver handles the 'default' keyboard,
144 * because unregistering the keyboard associated with the console will
145 * destroy its console association forever.
148 kbd_reinit_struct(keyboard_t *kbd, int config, int pref)
150 lwkt_gettoken(&tty_token);
151 kbd->kb_flags |= KB_NO_DEVICE; /* device has not been found */
152 kbd->kb_config = config & ~KB_CONF_PROBE_ONLY;
153 kbd->kb_led = 0; /* unknown */
155 kbd->kb_keymap = NULL;
156 kbd->kb_accentmap = NULL;
157 kbd->kb_fkeytab = NULL;
158 kbd->kb_fkeytab_size = 0;
159 kbd->kb_delay1 = KB_DELAY1; /* these values are advisory only */
160 kbd->kb_delay2 = KB_DELAY2;
163 bzero(kbd->kb_lastact, sizeof(kbd->kb_lastact));
164 lwkt_reltoken(&tty_token);
167 /* initialize the keyboard_t structure */
169 kbd_init_struct(keyboard_t *kbd, char *name, int type, int unit, int config,
170 int pref, int port, int port_size)
172 lwkt_gettoken(&tty_token);
177 kbd->kb_io_base = port;
178 kbd->kb_io_size = port_size;
179 kbd_reinit_struct(kbd, config, pref);
180 lockinit(&kbd->kb_lock, name, 0, LK_CANRECURSE);
181 lwkt_reltoken(&tty_token);
185 kbd_set_maps(keyboard_t *kbd, keymap_t *keymap, accentmap_t *accmap,
186 fkeytab_t *fkeymap, int fkeymap_size)
188 lwkt_gettoken(&tty_token);
189 kbd->kb_keymap = keymap;
190 kbd->kb_accentmap = accmap;
191 kbd->kb_fkeytab = fkeymap;
192 kbd->kb_fkeytab_size = fkeymap_size;
193 lwkt_reltoken(&tty_token);
196 /* declare a new keyboard driver */
198 kbd_add_driver(keyboard_driver_t *driver)
200 lwkt_gettoken(&tty_token);
201 if (SLIST_NEXT(driver, link)) {
202 lwkt_reltoken(&tty_token);
205 SLIST_INSERT_HEAD(&keyboard_drivers, driver, link);
206 lwkt_reltoken(&tty_token);
211 kbd_delete_driver(keyboard_driver_t *driver)
213 lwkt_gettoken(&tty_token);
214 SLIST_REMOVE(&keyboard_drivers, driver, keyboard_driver, link);
215 SLIST_NEXT(driver, link) = NULL;
216 lwkt_reltoken(&tty_token);
220 /* register a keyboard and associate it with a function table */
222 kbd_register(keyboard_t *kbd)
224 const keyboard_driver_t **list;
225 const keyboard_driver_t *p;
230 lwkt_gettoken(&tty_token);
231 mux = kbd_get_keyboard(kbd_find_keyboard("kbdmux", -1));
233 for (index = 0; index < keyboards; ++index) {
234 if (keyboard[index] == NULL)
237 if (index >= keyboards) {
238 if (kbd_realloc_array()) {
239 lwkt_reltoken(&tty_token);
244 kbd->kb_index = index;
247 kbd->kb_active = 0; /* disabled until someone calls kbd_enable() */
248 kbd->kb_token = NULL;
249 kbd->kb_callback.kc_func = NULL;
250 kbd->kb_callback.kc_arg = NULL;
251 callout_init_mp(&kbd->kb_atkbd_timeout_ch);
253 SLIST_FOREACH(p, &keyboard_drivers, link) {
254 if (strcmp(p->name, kbd->kb_name) == 0) {
255 keyboard[index] = kbd;
256 kbdsw[index] = p->kbdsw;
259 bzero(&ki, sizeof(ki));
260 strcpy(ki.kb_name, kbd->kb_name);
261 ki.kb_unit = kbd->kb_unit;
262 kbd_ioctl(mux, KBADDKBD, (caddr_t) &ki);
265 lwkt_reltoken(&tty_token);
269 SET_FOREACH(list, kbddriver_set) {
271 if (strcmp(p->name, kbd->kb_name) == 0) {
272 keyboard[index] = kbd;
273 kbdsw[index] = p->kbdsw;
276 bzero(&ki, sizeof(ki));
277 strcpy(ki.kb_name, kbd->kb_name);
278 ki.kb_unit = kbd->kb_unit;
279 kbd_ioctl(mux, KBADDKBD, (caddr_t) &ki);
282 lwkt_reltoken(&tty_token);
287 lwkt_reltoken(&tty_token);
292 kbd_unregister(keyboard_t *kbd)
296 KBD_LOCK_ASSERT(kbd);
297 lwkt_gettoken(&tty_token);
298 if ((kbd->kb_index < 0) || (kbd->kb_index >= keyboards)) {
299 lwkt_reltoken(&tty_token);
302 if (keyboard[kbd->kb_index] != kbd) {
303 lwkt_reltoken(&tty_token);
308 callout_stop(&kbd->kb_atkbd_timeout_ch);
309 if (KBD_IS_BUSY(kbd)) {
310 error = (*kbd->kb_callback.kc_func)(kbd, KBDIO_UNLOADING,
311 kbd->kb_callback.kc_arg);
314 lwkt_reltoken(&tty_token);
317 if (KBD_IS_BUSY(kbd)) {
319 lwkt_reltoken(&tty_token);
323 KBD_CONFIG_LOST(kbd);
325 keyboard[kbd->kb_index] = NULL;
326 kbdsw[kbd->kb_index] = NULL;
328 KBD_ALWAYS_UNLOCK(kbd);
329 lockuninit(&kbd->kb_lock);
332 lwkt_reltoken(&tty_token);
336 /* find a funciton table by the driver name */
338 kbd_get_switch(char *driver)
340 const keyboard_driver_t **list;
341 const keyboard_driver_t *p;
343 lwkt_gettoken(&tty_token);
345 SLIST_FOREACH(p, &keyboard_drivers, link) {
346 if (strcmp(p->name, driver) == 0) {
347 lwkt_reltoken(&tty_token);
351 SET_FOREACH(list, kbddriver_set) {
353 if (strcmp(p->name, driver) == 0) {
354 lwkt_reltoken(&tty_token);
359 lwkt_reltoken(&tty_token);
364 * Keyboard client functions
365 * Keyboard clients, such as the console driver `syscons' and the keyboard
366 * cdev driver, use these functions to claim and release a keyboard for
370 * find the keyboard specified by a driver name and a unit number
371 * starting at given index
374 kbd_find_keyboard2(char *driver, int unit, int index, int legacy)
383 lwkt_gettoken(&tty_token);
384 if ((index < 0) || (index >= keyboards)) {
385 lwkt_reltoken(&tty_token);
389 for (i = index; i < keyboards; ++i) {
390 if (keyboard[i] == NULL)
392 if (!KBD_IS_VALID(keyboard[i]))
394 if (strcmp("*", driver) && strcmp(keyboard[i]->kb_name, driver))
396 if ((unit != -1) && (keyboard[i]->kb_unit != unit))
399 * If we are in legacy mode, we do the old preference magic and
400 * don't return on the first found unit.
403 if (pref <= keyboard[i]->kb_pref) {
404 pref = keyboard[i]->kb_pref;
408 lwkt_reltoken(&tty_token);
414 KKASSERT(pref_index == -1);
416 lwkt_reltoken(&tty_token);
420 /* find the keyboard specified by a driver name and a unit number */
422 kbd_find_keyboard(char *driver, int unit)
424 return (kbd_find_keyboard2(driver, unit, 0, 1));
427 /* allocate a keyboard */
429 kbd_allocate(char *driver, int unit, void *id, kbd_callback_func_t *func,
438 lwkt_gettoken(&tty_token);
440 index = kbd_find_keyboard(driver, unit);
442 if (KBD_IS_BUSY(keyboard[index])) {
444 lwkt_reltoken(&tty_token);
447 keyboard[index]->kb_token = id;
448 KBD_BUSY(keyboard[index]);
449 keyboard[index]->kb_callback.kc_func = func;
450 keyboard[index]->kb_callback.kc_arg = arg;
451 kbd_clear_state(keyboard[index]);
454 lwkt_reltoken(&tty_token);
460 kbd_release(keyboard_t *kbd, void *id)
465 lwkt_gettoken(&tty_token);
467 if (!KBD_IS_VALID(kbd) || !KBD_IS_BUSY(kbd)) {
469 } else if (kbd->kb_token != id) {
472 kbd->kb_token = NULL;
474 kbd->kb_callback.kc_func = NULL;
475 kbd->kb_callback.kc_arg = NULL;
476 kbd_clear_state(kbd);
480 lwkt_reltoken(&tty_token);
486 kbd_change_callback(keyboard_t *kbd, void *id, kbd_callback_func_t *func,
492 lwkt_gettoken(&tty_token);
494 if (!KBD_IS_VALID(kbd) || !KBD_IS_BUSY(kbd)) {
496 } else if (kbd->kb_token != id) {
498 } else if (func == NULL) {
501 kbd->kb_callback.kc_func = func;
502 kbd->kb_callback.kc_arg = arg;
506 lwkt_reltoken(&tty_token);
511 /* get a keyboard structure */
513 kbd_get_keyboard(int index)
517 lwkt_gettoken(&tty_token);
518 if ((index < 0) || (index >= keyboards)) {
519 lwkt_reltoken(&tty_token);
522 if (keyboard[index] == NULL) {
523 lwkt_reltoken(&tty_token);
526 if (!KBD_IS_VALID(keyboard[index])) {
527 lwkt_reltoken(&tty_token);
530 kbd = keyboard[index];
531 lwkt_reltoken(&tty_token);
537 * The back door for the console driver; configure keyboards
538 * This function is for the kernel console to initialize keyboards
539 * at very early stage.
543 kbd_configure(int flags)
545 const keyboard_driver_t **list;
546 const keyboard_driver_t *p;
548 lwkt_gettoken(&tty_token);
550 SLIST_FOREACH(p, &keyboard_drivers, link) {
551 if (p->configure != NULL)
552 (*p->configure)(flags);
554 SET_FOREACH(list, kbddriver_set) {
556 if (p->configure != NULL)
557 (*p->configure)(flags);
560 lwkt_reltoken(&tty_token);
564 #ifdef KBD_INSTALL_CDEV
567 * Virtual keyboard cdev driver functions
568 * The virtual keyboard driver dispatches driver functions to
569 * appropriate subdrivers.
572 #define KBD_UNIT(dev) minor(dev)
574 static d_open_t genkbdopen;
575 static d_close_t genkbdclose;
576 static d_read_t genkbdread;
577 static d_write_t genkbdwrite;
578 static d_ioctl_t genkbdioctl;
579 static d_kqfilter_t genkbdkqfilter;
581 static void genkbdfiltdetach(struct knote *);
582 static int genkbdfilter(struct knote *, long);
584 static struct dev_ops kbd_ops = {
586 .d_open = genkbdopen,
587 .d_close = genkbdclose,
588 .d_read = genkbdread,
589 .d_write = genkbdwrite,
590 .d_ioctl = genkbdioctl,
591 .d_kqfilter = genkbdkqfilter
597 * NOTE: The usb driver does not detach the default keyboard if it is
598 * unplugged, but calls kbd_attach() when it is plugged back in.
601 kbd_attach(keyboard_t *kbd)
605 lwkt_gettoken(&tty_token);
606 if (kbd->kb_index >= keyboards) {
607 lwkt_reltoken(&tty_token);
610 if (keyboard[kbd->kb_index] != kbd) {
611 lwkt_reltoken(&tty_token);
615 if (kbd->kb_dev == NULL) {
616 kbd->kb_dev = make_dev(&kbd_ops, kbd->kb_index,
617 UID_ROOT, GID_WHEEL, 0600,
618 "kbd%r", kbd->kb_index);
621 if (dev->si_drv1 == NULL) {
622 dev->si_drv1 = kmalloc(sizeof(struct genkbd_softc), M_DEVBUF,
625 bzero(dev->si_drv1, sizeof(struct genkbd_softc));
627 kprintf("kbd%d at %s%d\n", kbd->kb_index, kbd->kb_name, kbd->kb_unit);
628 lwkt_reltoken(&tty_token);
633 kbd_detach(keyboard_t *kbd)
637 lwkt_gettoken(&tty_token);
639 if (kbd->kb_index >= keyboards) {
640 lwkt_reltoken(&tty_token);
643 if (keyboard[kbd->kb_index] != kbd) {
644 lwkt_reltoken(&tty_token);
648 if ((dev = kbd->kb_dev) != NULL) {
650 kfree(dev->si_drv1, M_DEVBUF);
655 dev_ops_remove_minor(&kbd_ops, kbd->kb_index);
656 lwkt_reltoken(&tty_token);
661 * Generic keyboard cdev driver functions
662 * Keyboard subdrivers may call these functions to implement common
667 genkbd_putc(genkbd_softc_t sc, char c)
671 lwkt_gettoken(&tty_token);
673 if (sc->gkb_q_length == KB_QSIZE) {
674 lwkt_reltoken(&tty_token);
678 p = (sc->gkb_q_start + sc->gkb_q_length) % KB_QSIZE;
682 lwkt_reltoken(&tty_token);
686 genkbd_getc(genkbd_softc_t sc, char *buf, size_t len)
689 lwkt_gettoken(&tty_token);
691 /* Determine copy size. */
692 if (sc->gkb_q_length == 0) {
693 lwkt_reltoken(&tty_token);
696 if (len >= sc->gkb_q_length)
697 len = sc->gkb_q_length;
698 if (len >= KB_QSIZE - sc->gkb_q_start)
699 len = KB_QSIZE - sc->gkb_q_start;
701 /* Copy out data and progress offset. */
702 memcpy(buf, sc->gkb_q + sc->gkb_q_start, len);
703 sc->gkb_q_start = (sc->gkb_q_start + len) % KB_QSIZE;
704 sc->gkb_q_length -= len;
706 lwkt_reltoken(&tty_token);
710 static kbd_callback_func_t genkbd_event;
713 genkbdopen(struct dev_open_args *ap)
715 cdev_t dev = ap->a_head.a_dev;
721 lwkt_gettoken(&tty_token);
723 kbd = kbd_get_keyboard(KBD_INDEX(dev));
724 if ((sc == NULL) || (kbd == NULL) || !KBD_IS_VALID(kbd)) {
725 lwkt_reltoken(&tty_token);
729 i = kbd_allocate(kbd->kb_name, kbd->kb_unit, sc,
732 lwkt_reltoken(&tty_token);
736 /* assert(i == kbd->kb_index) */
737 /* assert(kbd == kbd_get_keyboard(i)) */
740 * NOTE: even when we have successfully claimed a keyboard,
741 * the device may still be missing (!KBD_HAS_DEVICE(kbd)).
744 sc->gkb_q_length = 0;
745 lwkt_reltoken(&tty_token);
752 genkbdclose(struct dev_close_args *ap)
754 cdev_t dev = ap->a_head.a_dev;
759 * NOTE: the device may have already become invalid.
760 * kbd == NULL || !KBD_IS_VALID(kbd)
763 lwkt_gettoken(&tty_token);
765 kbd = kbd_get_keyboard(KBD_INDEX(dev));
766 if ((sc == NULL) || (kbd == NULL) || !KBD_IS_VALID(kbd)) {
767 /* XXX: we shall be forgiving and don't report error... */
769 kbd_release(kbd, sc);
771 lwkt_reltoken(&tty_token);
777 genkbdread(struct dev_read_args *ap)
779 cdev_t dev = ap->a_head.a_dev;
780 struct uio *uio = ap->a_uio;
783 u_char buffer[KB_BUFSIZE];
789 lwkt_gettoken(&tty_token);
791 kbd = kbd_get_keyboard(KBD_INDEX(dev));
792 if ((sc == NULL) || (kbd == NULL) || !KBD_IS_VALID(kbd)) {
793 lwkt_reltoken(&tty_token);
797 while (sc->gkb_q_length == 0) {
798 if (ap->a_ioflag & IO_NDELAY) { /* O_NONBLOCK? */
799 lwkt_reltoken(&tty_token);
803 sc->gkb_flags |= KB_ASLEEP;
804 error = tsleep((caddr_t)sc, PCATCH, "kbdrea", 0);
805 kbd = kbd_get_keyboard(KBD_INDEX(dev));
806 if ((kbd == NULL) || !KBD_IS_VALID(kbd)) {
807 lwkt_reltoken(&tty_token);
809 return ENXIO; /* our keyboard has gone... */
812 sc->gkb_flags &= ~KB_ASLEEP;
813 lwkt_reltoken(&tty_token);
818 lwkt_reltoken(&tty_token);
821 /* copy as much input as possible */
823 while (uio->uio_resid > 0) {
824 len = (int)szmin(uio->uio_resid, sizeof(buffer));
825 len = genkbd_getc(sc, buffer, len);
828 error = uiomove(buffer, (size_t)len, uio);
837 genkbdwrite(struct dev_write_args *ap)
839 cdev_t dev = ap->a_head.a_dev;
842 lwkt_gettoken(&tty_token);
843 kbd = kbd_get_keyboard(KBD_INDEX(dev));
844 if ((kbd == NULL) || !KBD_IS_VALID(kbd)) {
845 lwkt_reltoken(&tty_token);
848 lwkt_reltoken(&tty_token);
853 genkbdioctl(struct dev_ioctl_args *ap)
855 cdev_t dev = ap->a_head.a_dev;
859 lwkt_gettoken(&tty_token);
860 kbd = kbd_get_keyboard(KBD_INDEX(dev));
861 if ((kbd == NULL) || !KBD_IS_VALID(kbd)) {
862 lwkt_reltoken(&tty_token);
865 error = kbd_ioctl(kbd, ap->a_cmd, ap->a_data);
866 if (error == ENOIOCTL)
869 lwkt_reltoken(&tty_token);
873 static struct filterops genkbdfiltops =
874 { FILTEROP_ISFD, NULL, genkbdfiltdetach, genkbdfilter };
877 genkbdkqfilter(struct dev_kqfilter_args *ap)
879 cdev_t dev = ap->a_head.a_dev;
880 struct knote *kn = ap->a_kn;
886 switch (kn->kn_filter) {
888 kn->kn_fop = &genkbdfiltops;
889 kn->kn_hook = (caddr_t)dev;
892 ap->a_result = EOPNOTSUPP;
897 klist = &sc->gkb_rkq.ki_note;
898 knote_insert(klist, kn);
904 genkbdfiltdetach(struct knote *kn)
906 cdev_t dev = (cdev_t)kn->kn_hook;
911 klist = &sc->gkb_rkq.ki_note;
912 knote_remove(klist, kn);
916 genkbdfilter(struct knote *kn, long hint)
918 cdev_t dev = (cdev_t)kn->kn_hook;
924 lwkt_gettoken(&tty_token);
926 kbd = kbd_get_keyboard(KBD_INDEX(dev));
927 if ((sc == NULL) || (kbd == NULL) || !KBD_IS_VALID(kbd)) {
928 /* The keyboard has gone */
929 kn->kn_flags |= (EV_EOF | EV_NODATA);
932 if (sc->gkb_q_length > 0)
935 lwkt_reltoken(&tty_token);
942 genkbd_event(keyboard_t *kbd, int event, void *arg)
950 lwkt_gettoken(&tty_token);
951 /* assert(KBD_IS_VALID(kbd)) */
952 sc = (genkbd_softc_t)arg;
957 case KBDIO_UNLOADING:
958 /* the keyboard is going... */
959 kbd_release(kbd, sc);
960 if (sc->gkb_flags & KB_ASLEEP) {
961 sc->gkb_flags &= ~KB_ASLEEP;
964 KNOTE(&sc->gkb_rkq.ki_note, 0);
965 lwkt_reltoken(&tty_token);
968 lwkt_reltoken(&tty_token);
972 /* obtain the current key input mode */
973 if (kbd_ioctl(kbd, KDGKBMODE, (caddr_t)&mode))
976 /* read all pending input */
977 while (kbd_check_char(kbd)) {
978 c = kbd_read_char(kbd, FALSE);
981 if (c == ERRKEY) /* XXX: ring bell? */
983 if (!KBD_IS_BUSY(kbd))
984 /* the device is not open, discard the input */
987 /* store the byte as is for K_RAW and K_CODE modes */
988 if (mode != K_XLATE) {
989 genkbd_putc(sc, KEYCHAR(c));
994 if (c & RELKEY) /* key release is ignored */
997 /* process special keys; most of them are just ignored... */
999 switch (KEYCHAR(c)) {
1001 /* ignore them... */
1003 case BTAB: /* a backtab: ESC [ Z */
1004 genkbd_putc(sc, 0x1b);
1005 genkbd_putc(sc, '[');
1006 genkbd_putc(sc, 'Z');
1011 /* normal chars, normal chars with the META, function keys */
1012 switch (KEYFLAGS(c)) {
1013 case 0: /* a normal char */
1014 genkbd_putc(sc, KEYCHAR(c));
1016 case MKEY: /* the META flag: prepend ESC */
1017 genkbd_putc(sc, 0x1b);
1018 genkbd_putc(sc, KEYCHAR(c));
1020 case FKEY | SPCLKEY: /* a function key, return string */
1021 cp = kbd_get_fkeystr(kbd, KEYCHAR(c), &len);
1024 genkbd_putc(sc, *cp++);
1030 /* wake up sleeping/polling processes */
1031 if (sc->gkb_q_length > 0) {
1032 if (sc->gkb_flags & KB_ASLEEP) {
1033 sc->gkb_flags &= ~KB_ASLEEP;
1034 wakeup((caddr_t)sc);
1036 KNOTE(&sc->gkb_rkq.ki_note, 0);
1039 lwkt_reltoken(&tty_token);
1043 #endif /* KBD_INSTALL_CDEV */
1046 * Generic low-level keyboard functions
1047 * The low-level functions in the keyboard subdriver may use these
1052 genkbd_commonioctl(keyboard_t *kbd, u_long cmd, caddr_t arg)
1059 lwkt_gettoken(&tty_token);
1062 case KDGKBINFO: /* get keyboard information */
1063 ((keyboard_info_t *)arg)->kb_index = kbd->kb_index;
1064 i = imin(strlen(kbd->kb_name) + 1,
1065 sizeof(((keyboard_info_t *)arg)->kb_name));
1066 bcopy(kbd->kb_name, ((keyboard_info_t *)arg)->kb_name, i);
1067 ((keyboard_info_t *)arg)->kb_unit = kbd->kb_unit;
1068 ((keyboard_info_t *)arg)->kb_type = kbd->kb_type;
1069 ((keyboard_info_t *)arg)->kb_config = kbd->kb_config;
1070 ((keyboard_info_t *)arg)->kb_flags = kbd->kb_flags;
1073 case KDGKBTYPE: /* get keyboard type */
1074 *(int *)arg = kbd->kb_type;
1077 case KDGETREPEAT: /* get keyboard repeat rate */
1078 ((int *)arg)[0] = kbd->kb_delay1;
1079 ((int *)arg)[1] = kbd->kb_delay2;
1082 case GIO_KEYMAP: /* get keyboard translation table */
1083 bcopy(kbd->kb_keymap, arg, sizeof(*kbd->kb_keymap));
1085 case PIO_KEYMAP: /* set keyboard translation table */
1086 #ifndef KBD_DISABLE_KEYMAP_LOAD
1087 bzero(kbd->kb_accentmap, sizeof(*kbd->kb_accentmap));
1088 bcopy(arg, kbd->kb_keymap, sizeof(*kbd->kb_keymap));
1091 lwkt_reltoken(&tty_token);
1096 case GIO_KEYMAPENT: /* get keyboard translation table entry */
1097 keyp = (keyarg_t *)arg;
1098 if (keyp->keynum >= sizeof(kbd->kb_keymap->key)
1099 /sizeof(kbd->kb_keymap->key[0])) {
1100 lwkt_reltoken(&tty_token);
1104 bcopy(&kbd->kb_keymap->key[keyp->keynum], &keyp->key,
1107 case PIO_KEYMAPENT: /* set keyboard translation table entry */
1108 #ifndef KBD_DISABLE_KEYMAP_LOAD
1109 keyp = (keyarg_t *)arg;
1110 if (keyp->keynum >= sizeof(kbd->kb_keymap->key)
1111 /sizeof(kbd->kb_keymap->key[0])) {
1112 lwkt_reltoken(&tty_token);
1116 bcopy(&keyp->key, &kbd->kb_keymap->key[keyp->keynum],
1120 lwkt_reltoken(&tty_token);
1125 case GIO_DEADKEYMAP: /* get accent key translation table */
1126 bcopy(kbd->kb_accentmap, arg, sizeof(*kbd->kb_accentmap));
1128 case PIO_DEADKEYMAP: /* set accent key translation table */
1129 #ifndef KBD_DISABLE_KEYMAP_LOAD
1130 bcopy(arg, kbd->kb_accentmap, sizeof(*kbd->kb_accentmap));
1133 lwkt_reltoken(&tty_token);
1138 case GETFKEY: /* get functionkey string */
1139 fkeyp = (fkeyarg_t *)arg;
1140 if (fkeyp->keynum >= kbd->kb_fkeytab_size) {
1141 lwkt_reltoken(&tty_token);
1145 bcopy(kbd->kb_fkeytab[fkeyp->keynum].str, fkeyp->keydef,
1146 kbd->kb_fkeytab[fkeyp->keynum].len);
1147 fkeyp->flen = kbd->kb_fkeytab[fkeyp->keynum].len;
1149 case SETFKEY: /* set functionkey string */
1150 #ifndef KBD_DISABLE_KEYMAP_LOAD
1151 fkeyp = (fkeyarg_t *)arg;
1152 if (fkeyp->keynum >= kbd->kb_fkeytab_size) {
1153 lwkt_reltoken(&tty_token);
1157 kbd->kb_fkeytab[fkeyp->keynum].len = imin(fkeyp->flen, MAXFK);
1158 bcopy(fkeyp->keydef, kbd->kb_fkeytab[fkeyp->keynum].str,
1159 kbd->kb_fkeytab[fkeyp->keynum].len);
1162 lwkt_reltoken(&tty_token);
1168 lwkt_reltoken(&tty_token);
1173 lwkt_reltoken(&tty_token);
1178 /* get a pointer to the string associated with the given function key */
1180 genkbd_get_fkeystr(keyboard_t *kbd, int fkey, size_t *len)
1187 lwkt_gettoken(&tty_token);
1189 if (fkey > kbd->kb_fkeytab_size) {
1190 lwkt_reltoken(&tty_token);
1193 *len = kbd->kb_fkeytab[fkey].len;
1194 ch = kbd->kb_fkeytab[fkey].str;
1196 lwkt_reltoken(&tty_token);
1200 /* diagnostic dump */
1202 get_kbd_type_name(int type)
1209 { KB_101, "AT 101/102" },
1210 { KB_OTHER, "generic" },
1214 for (i = 0; i < NELEM(name_table); ++i) {
1215 if (type == name_table[i].type)
1216 return name_table[i].name;
1222 genkbd_diag(keyboard_t *kbd, int level)
1225 kprintf("kbd%d: %s%d, %s (%d), config:0x%x, flags:0x%x",
1226 kbd->kb_index, kbd->kb_name, kbd->kb_unit,
1227 get_kbd_type_name(kbd->kb_type), kbd->kb_type,
1228 kbd->kb_config, kbd->kb_flags);
1229 if (kbd->kb_io_base > 0)
1230 kprintf(", port:0x%x-0x%x", kbd->kb_io_base,
1231 kbd->kb_io_base + kbd->kb_io_size - 1);
1236 #define set_lockkey_state(k, s, l) \
1237 if (!((s) & l ## DOWN)) { \
1241 i = (s) & LOCK_MASK; \
1242 kbd_ioctl((k), KDSETLED, (caddr_t)&i); \
1246 save_accent_key(keyboard_t *kbd, u_int key, int *accents)
1250 lwkt_gettoken(&tty_token);
1251 /* make an index into the accent map */
1252 i = key - F_ACC + 1;
1253 if ((i > kbd->kb_accentmap->n_accs)
1254 || (kbd->kb_accentmap->acc[i - 1].accchar == 0)) {
1255 /* the index is out of range or pointing to an empty entry */
1257 lwkt_reltoken(&tty_token);
1262 * If the same accent key has been hit twice, produce the accent char
1265 if (i == *accents) {
1266 key = kbd->kb_accentmap->acc[i - 1].accchar;
1268 lwkt_reltoken(&tty_token);
1272 /* remember the index and wait for the next key */
1274 lwkt_reltoken(&tty_token);
1279 make_accent_char(keyboard_t *kbd, u_int ch, int *accents)
1284 lwkt_gettoken(&tty_token);
1285 acc = &kbd->kb_accentmap->acc[*accents - 1];
1289 * If the accent key is followed by the space key,
1290 * produce the accent char itself.
1293 lwkt_reltoken(&tty_token);
1294 return acc->accchar;
1297 /* scan the accent map */
1298 for (i = 0; i < NUM_ACCENTCHARS; ++i) {
1299 if (acc->map[i][0] == 0) /* end of table */
1301 if (acc->map[i][0] == ch) {
1302 lwkt_reltoken(&tty_token);
1303 return acc->map[i][1];
1306 lwkt_reltoken(&tty_token);
1307 /* this char cannot be accented... */
1312 genkbd_keyaction(keyboard_t *kbd, int keycode, int up, int *shiftstate,
1315 struct keyent_t *key;
1316 int state = *shiftstate;
1321 lwkt_gettoken(&tty_token);
1323 f = state & (AGRS | ALKED);
1324 if ((f == AGRS1) || (f == AGRS2) || (f == ALKED))
1326 key = &kbd->kb_keymap->key[i];
1327 i = ((state & SHIFTS) ? 1 : 0)
1328 | ((state & CTLS) ? 2 : 0)
1329 | ((state & ALTS) ? 4 : 0);
1330 if (((key->flgs & FLAG_LOCK_C) && (state & CLKED))
1331 || ((key->flgs & FLAG_LOCK_N) && (state & NLKED)) )
1334 if (up) { /* break: key released */
1335 action = kbd->kb_lastact[keycode];
1336 kbd->kb_lastact[keycode] = NOP;
1339 if (state & SHIFTAON) {
1340 set_lockkey_state(kbd, state, ALK);
1349 if (state & SHIFTAON) {
1350 set_lockkey_state(kbd, state, ALK);
1359 if (state & SHIFTAON) {
1360 set_lockkey_state(kbd, state, ALK);
1369 if (state & SHIFTAON) {
1370 set_lockkey_state(kbd, state, ALK);
1379 if (state & SHIFTAON) {
1380 set_lockkey_state(kbd, state, ALK);
1389 if (state & SHIFTAON) {
1390 set_lockkey_state(kbd, state, ALK);
1417 /* release events of regular keys are not reported */
1418 *shiftstate &= ~SHIFTAON;
1419 lwkt_reltoken(&tty_token);
1422 *shiftstate = state & ~SHIFTAON;
1423 lwkt_reltoken(&tty_token);
1424 return (SPCLKEY | RELKEY | action);
1425 } else { /* make: key pressed */
1426 action = key->map[i];
1428 if (key->spcl & (0x80 >> i)) {
1430 if (kbd->kb_lastact[keycode] == NOP)
1431 kbd->kb_lastact[keycode] = action;
1432 if (kbd->kb_lastact[keycode] != action)
1437 set_lockkey_state(kbd, state, NLK);
1440 set_lockkey_state(kbd, state, CLK);
1443 set_lockkey_state(kbd, state, SLK);
1446 set_lockkey_state(kbd, state, ALK);
1448 /* NON-LOCKING KEYS */
1449 case SPSC: case RBT: case SUSP: case STBY:
1450 case DBG: case NEXT: case PREV: case PNC:
1451 case HALT: case PDWN:
1507 *shiftstate = state;
1508 lwkt_reltoken(&tty_token);
1511 /* is this an accent (dead) key? */
1512 *shiftstate = state;
1513 if (action >= F_ACC && action <= L_ACC) {
1514 action = save_accent_key(kbd, action,
1519 lwkt_reltoken(&tty_token);
1522 if (state & METAS) {
1523 lwkt_reltoken(&tty_token);
1524 return (action | MKEY);
1526 lwkt_reltoken(&tty_token);
1532 /* other special keys */
1535 lwkt_reltoken(&tty_token);
1538 if (action >= F_FN && action <= L_FN)
1540 /* XXX: return fkey string for the FKEY? */
1541 lwkt_reltoken(&tty_token);
1542 return (SPCLKEY | action);
1544 *shiftstate = state;
1545 lwkt_reltoken(&tty_token);
1546 return (SPCLKEY | action);
1549 kbd->kb_lastact[keycode] = NOP;
1550 *shiftstate = state;
1552 /* make an accented char */
1553 action = make_accent_char(kbd, action, accents);
1554 if (action == ERRKEY) {
1555 lwkt_reltoken(&tty_token);
1561 lwkt_reltoken(&tty_token);
1566 lwkt_reltoken(&tty_token);