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 lwkt_gettoken(&tty_token);
297 if ((kbd->kb_index < 0) || (kbd->kb_index >= keyboards)) {
298 lwkt_reltoken(&tty_token);
301 if (keyboard[kbd->kb_index] != kbd) {
302 lwkt_reltoken(&tty_token);
307 callout_stop(&kbd->kb_atkbd_timeout_ch);
308 if (KBD_IS_BUSY(kbd)) {
309 error = (*kbd->kb_callback.kc_func)(kbd, KBDIO_UNLOADING,
310 kbd->kb_callback.kc_arg);
313 lwkt_reltoken(&tty_token);
316 if (KBD_IS_BUSY(kbd)) {
318 lwkt_reltoken(&tty_token);
322 KBD_CONFIG_LOST(kbd);
324 keyboard[kbd->kb_index] = NULL;
325 kbdsw[kbd->kb_index] = NULL;
327 KBD_ALWAYS_UNLOCK(kbd);
328 lockuninit(&kbd->kb_lock);
331 lwkt_reltoken(&tty_token);
335 /* find a funciton table by the driver name */
337 kbd_get_switch(char *driver)
339 const keyboard_driver_t **list;
340 const keyboard_driver_t *p;
342 lwkt_gettoken(&tty_token);
344 SLIST_FOREACH(p, &keyboard_drivers, link) {
345 if (strcmp(p->name, driver) == 0) {
346 lwkt_reltoken(&tty_token);
350 SET_FOREACH(list, kbddriver_set) {
352 if (strcmp(p->name, driver) == 0) {
353 lwkt_reltoken(&tty_token);
358 lwkt_reltoken(&tty_token);
363 * Keyboard client functions
364 * Keyboard clients, such as the console driver `syscons' and the keyboard
365 * cdev driver, use these functions to claim and release a keyboard for
369 * find the keyboard specified by a driver name and a unit number
370 * starting at given index
373 kbd_find_keyboard2(char *driver, int unit, int index, int legacy)
382 lwkt_gettoken(&tty_token);
383 if ((index < 0) || (index >= keyboards)) {
384 lwkt_reltoken(&tty_token);
388 for (i = index; i < keyboards; ++i) {
389 if (keyboard[i] == NULL)
391 if (!KBD_IS_VALID(keyboard[i]))
393 if (strcmp("*", driver) && strcmp(keyboard[i]->kb_name, driver))
395 if ((unit != -1) && (keyboard[i]->kb_unit != unit))
398 * If we are in legacy mode, we do the old preference magic and
399 * don't return on the first found unit.
402 if (pref <= keyboard[i]->kb_pref) {
403 pref = keyboard[i]->kb_pref;
407 lwkt_reltoken(&tty_token);
413 KKASSERT(pref_index == -1);
415 lwkt_reltoken(&tty_token);
419 /* find the keyboard specified by a driver name and a unit number */
421 kbd_find_keyboard(char *driver, int unit)
423 return (kbd_find_keyboard2(driver, unit, 0, 1));
426 /* allocate a keyboard */
428 kbd_allocate(char *driver, int unit, void *id, kbd_callback_func_t *func,
437 lwkt_gettoken(&tty_token);
439 index = kbd_find_keyboard(driver, unit);
441 if (KBD_IS_BUSY(keyboard[index])) {
443 lwkt_reltoken(&tty_token);
446 keyboard[index]->kb_token = id;
447 KBD_BUSY(keyboard[index]);
448 keyboard[index]->kb_callback.kc_func = func;
449 keyboard[index]->kb_callback.kc_arg = arg;
450 kbd_clear_state(keyboard[index]);
453 lwkt_reltoken(&tty_token);
459 kbd_release(keyboard_t *kbd, void *id)
464 lwkt_gettoken(&tty_token);
466 if (!KBD_IS_VALID(kbd) || !KBD_IS_BUSY(kbd)) {
468 } else if (kbd->kb_token != id) {
471 kbd->kb_token = NULL;
473 kbd->kb_callback.kc_func = NULL;
474 kbd->kb_callback.kc_arg = NULL;
475 kbd_clear_state(kbd);
479 lwkt_reltoken(&tty_token);
485 kbd_change_callback(keyboard_t *kbd, void *id, kbd_callback_func_t *func,
491 lwkt_gettoken(&tty_token);
493 if (!KBD_IS_VALID(kbd) || !KBD_IS_BUSY(kbd)) {
495 } else if (kbd->kb_token != id) {
497 } else if (func == NULL) {
500 kbd->kb_callback.kc_func = func;
501 kbd->kb_callback.kc_arg = arg;
505 lwkt_reltoken(&tty_token);
510 /* get a keyboard structure */
512 kbd_get_keyboard(int index)
516 lwkt_gettoken(&tty_token);
517 if ((index < 0) || (index >= keyboards)) {
518 lwkt_reltoken(&tty_token);
521 if (keyboard[index] == NULL) {
522 lwkt_reltoken(&tty_token);
525 if (!KBD_IS_VALID(keyboard[index])) {
526 lwkt_reltoken(&tty_token);
529 kbd = keyboard[index];
530 lwkt_reltoken(&tty_token);
536 * The back door for the console driver; configure keyboards
537 * This function is for the kernel console to initialize keyboards
538 * at very early stage.
542 kbd_configure(int flags)
544 const keyboard_driver_t **list;
545 const keyboard_driver_t *p;
547 lwkt_gettoken(&tty_token);
549 SLIST_FOREACH(p, &keyboard_drivers, link) {
550 if (p->configure != NULL)
551 (*p->configure)(flags);
553 SET_FOREACH(list, kbddriver_set) {
555 if (p->configure != NULL)
556 (*p->configure)(flags);
559 lwkt_reltoken(&tty_token);
563 #ifdef KBD_INSTALL_CDEV
566 * Virtual keyboard cdev driver functions
567 * The virtual keyboard driver dispatches driver functions to
568 * appropriate subdrivers.
571 #define KBD_UNIT(dev) minor(dev)
573 static d_open_t genkbdopen;
574 static d_close_t genkbdclose;
575 static d_read_t genkbdread;
576 static d_write_t genkbdwrite;
577 static d_ioctl_t genkbdioctl;
578 static d_kqfilter_t genkbdkqfilter;
580 static void genkbdfiltdetach(struct knote *);
581 static int genkbdfilter(struct knote *, long);
583 static struct dev_ops kbd_ops = {
585 .d_open = genkbdopen,
586 .d_close = genkbdclose,
587 .d_read = genkbdread,
588 .d_write = genkbdwrite,
589 .d_ioctl = genkbdioctl,
590 .d_kqfilter = genkbdkqfilter
596 * NOTE: The usb driver does not detach the default keyboard if it is
597 * unplugged, but calls kbd_attach() when it is plugged back in.
600 kbd_attach(keyboard_t *kbd)
604 lwkt_gettoken(&tty_token);
605 if (kbd->kb_index >= keyboards) {
606 lwkt_reltoken(&tty_token);
609 if (keyboard[kbd->kb_index] != kbd) {
610 lwkt_reltoken(&tty_token);
614 if (kbd->kb_dev == NULL) {
615 kbd->kb_dev = make_dev(&kbd_ops, kbd->kb_index,
616 UID_ROOT, GID_WHEEL, 0600,
617 "kbd%r", kbd->kb_index);
620 if (dev->si_drv1 == NULL) {
621 dev->si_drv1 = kmalloc(sizeof(struct genkbd_softc), M_DEVBUF,
624 bzero(dev->si_drv1, sizeof(struct genkbd_softc));
626 kprintf("kbd%d at %s%d\n", kbd->kb_index, kbd->kb_name, kbd->kb_unit);
627 lwkt_reltoken(&tty_token);
632 kbd_detach(keyboard_t *kbd)
636 lwkt_gettoken(&tty_token);
638 if (kbd->kb_index >= keyboards) {
639 lwkt_reltoken(&tty_token);
642 if (keyboard[kbd->kb_index] != kbd) {
643 lwkt_reltoken(&tty_token);
647 if ((dev = kbd->kb_dev) != NULL) {
649 kfree(dev->si_drv1, M_DEVBUF);
654 dev_ops_remove_minor(&kbd_ops, kbd->kb_index);
655 lwkt_reltoken(&tty_token);
660 * Generic keyboard cdev driver functions
661 * Keyboard subdrivers may call these functions to implement common
666 genkbd_putc(genkbd_softc_t sc, char c)
670 lwkt_gettoken(&tty_token);
672 if (sc->gkb_q_length == KB_QSIZE) {
673 lwkt_reltoken(&tty_token);
677 p = (sc->gkb_q_start + sc->gkb_q_length) % KB_QSIZE;
681 lwkt_reltoken(&tty_token);
685 genkbd_getc(genkbd_softc_t sc, char *buf, size_t len)
688 lwkt_gettoken(&tty_token);
690 /* Determine copy size. */
691 if (sc->gkb_q_length == 0) {
692 lwkt_reltoken(&tty_token);
695 if (len >= sc->gkb_q_length)
696 len = sc->gkb_q_length;
697 if (len >= KB_QSIZE - sc->gkb_q_start)
698 len = KB_QSIZE - sc->gkb_q_start;
700 /* Copy out data and progress offset. */
701 memcpy(buf, sc->gkb_q + sc->gkb_q_start, len);
702 sc->gkb_q_start = (sc->gkb_q_start + len) % KB_QSIZE;
703 sc->gkb_q_length -= len;
705 lwkt_reltoken(&tty_token);
709 static kbd_callback_func_t genkbd_event;
712 genkbdopen(struct dev_open_args *ap)
714 cdev_t dev = ap->a_head.a_dev;
720 lwkt_gettoken(&tty_token);
722 kbd = kbd_get_keyboard(KBD_INDEX(dev));
723 if ((sc == NULL) || (kbd == NULL) || !KBD_IS_VALID(kbd)) {
724 lwkt_reltoken(&tty_token);
728 i = kbd_allocate(kbd->kb_name, kbd->kb_unit, sc,
729 genkbd_event, (void *)sc);
731 lwkt_reltoken(&tty_token);
735 /* assert(i == kbd->kb_index) */
736 /* assert(kbd == kbd_get_keyboard(i)) */
739 * NOTE: even when we have successfully claimed a keyboard,
740 * the device may still be missing (!KBD_HAS_DEVICE(kbd)).
743 sc->gkb_q_length = 0;
744 lwkt_reltoken(&tty_token);
751 genkbdclose(struct dev_close_args *ap)
753 cdev_t dev = ap->a_head.a_dev;
758 * NOTE: the device may have already become invalid.
759 * kbd == NULL || !KBD_IS_VALID(kbd)
762 lwkt_gettoken(&tty_token);
764 kbd = kbd_get_keyboard(KBD_INDEX(dev));
765 if ((sc == NULL) || (kbd == NULL) || !KBD_IS_VALID(kbd)) {
766 /* XXX: we shall be forgiving and don't report error... */
768 kbd_release(kbd, (void *)sc);
770 lwkt_reltoken(&tty_token);
776 genkbdread(struct dev_read_args *ap)
778 cdev_t dev = ap->a_head.a_dev;
779 struct uio *uio = ap->a_uio;
782 u_char buffer[KB_BUFSIZE];
788 lwkt_gettoken(&tty_token);
790 kbd = kbd_get_keyboard(KBD_INDEX(dev));
791 if ((sc == NULL) || (kbd == NULL) || !KBD_IS_VALID(kbd)) {
792 lwkt_reltoken(&tty_token);
796 while (sc->gkb_q_length == 0) {
797 if (ap->a_ioflag & IO_NDELAY) { /* O_NONBLOCK? */
798 lwkt_reltoken(&tty_token);
802 sc->gkb_flags |= KB_ASLEEP;
803 error = tsleep((caddr_t)sc, PCATCH, "kbdrea", 0);
804 kbd = kbd_get_keyboard(KBD_INDEX(dev));
805 if ((kbd == NULL) || !KBD_IS_VALID(kbd)) {
806 lwkt_reltoken(&tty_token);
808 return ENXIO; /* our keyboard has gone... */
811 sc->gkb_flags &= ~KB_ASLEEP;
812 lwkt_reltoken(&tty_token);
817 lwkt_reltoken(&tty_token);
820 /* copy as much input as possible */
822 while (uio->uio_resid > 0) {
823 len = (int)szmin(uio->uio_resid, sizeof(buffer));
824 len = genkbd_getc(sc, buffer, len);
827 error = uiomove(buffer, (size_t)len, uio);
836 genkbdwrite(struct dev_write_args *ap)
838 cdev_t dev = ap->a_head.a_dev;
841 lwkt_gettoken(&tty_token);
842 kbd = kbd_get_keyboard(KBD_INDEX(dev));
843 if ((kbd == NULL) || !KBD_IS_VALID(kbd)) {
844 lwkt_reltoken(&tty_token);
847 lwkt_reltoken(&tty_token);
852 genkbdioctl(struct dev_ioctl_args *ap)
854 cdev_t dev = ap->a_head.a_dev;
858 lwkt_gettoken(&tty_token);
859 kbd = kbd_get_keyboard(KBD_INDEX(dev));
860 if ((kbd == NULL) || !KBD_IS_VALID(kbd)) {
861 lwkt_reltoken(&tty_token);
864 error = kbd_ioctl(kbd, ap->a_cmd, ap->a_data);
865 if (error == ENOIOCTL)
868 lwkt_reltoken(&tty_token);
872 static struct filterops genkbdfiltops =
873 { FILTEROP_ISFD, NULL, genkbdfiltdetach, genkbdfilter };
876 genkbdkqfilter(struct dev_kqfilter_args *ap)
878 cdev_t dev = ap->a_head.a_dev;
879 struct knote *kn = ap->a_kn;
885 switch (kn->kn_filter) {
887 kn->kn_fop = &genkbdfiltops;
888 kn->kn_hook = (caddr_t)dev;
891 ap->a_result = EOPNOTSUPP;
896 klist = &sc->gkb_rkq.ki_note;
897 knote_insert(klist, kn);
903 genkbdfiltdetach(struct knote *kn)
905 cdev_t dev = (cdev_t)kn->kn_hook;
910 klist = &sc->gkb_rkq.ki_note;
911 knote_remove(klist, kn);
915 genkbdfilter(struct knote *kn, long hint)
917 cdev_t dev = (cdev_t)kn->kn_hook;
923 lwkt_gettoken(&tty_token);
925 kbd = kbd_get_keyboard(KBD_INDEX(dev));
926 if ((sc == NULL) || (kbd == NULL) || !KBD_IS_VALID(kbd)) {
927 kn->kn_flags |= EV_EOF; /* the keyboard has gone */
930 if (sc->gkb_q_length > 0)
933 lwkt_reltoken(&tty_token);
940 genkbd_event(keyboard_t *kbd, int event, void *arg)
948 lwkt_gettoken(&tty_token);
949 /* assert(KBD_IS_VALID(kbd)) */
950 sc = (genkbd_softc_t)arg;
955 case KBDIO_UNLOADING:
956 /* the keyboard is going... */
957 kbd_release(kbd, (void *)sc);
958 if (sc->gkb_flags & KB_ASLEEP) {
959 sc->gkb_flags &= ~KB_ASLEEP;
962 KNOTE(&sc->gkb_rkq.ki_note, 0);
963 lwkt_reltoken(&tty_token);
966 lwkt_reltoken(&tty_token);
970 /* obtain the current key input mode */
971 if (kbd_ioctl(kbd, KDGKBMODE, (caddr_t)&mode))
974 /* read all pending input */
975 while (kbd_check_char(kbd)) {
976 c = kbd_read_char(kbd, FALSE);
979 if (c == ERRKEY) /* XXX: ring bell? */
981 if (!KBD_IS_BUSY(kbd))
982 /* the device is not open, discard the input */
985 /* store the byte as is for K_RAW and K_CODE modes */
986 if (mode != K_XLATE) {
987 genkbd_putc(sc, KEYCHAR(c));
992 if (c & RELKEY) /* key release is ignored */
995 /* process special keys; most of them are just ignored... */
997 switch (KEYCHAR(c)) {
1001 case BTAB: /* a backtab: ESC [ Z */
1002 genkbd_putc(sc, 0x1b);
1003 genkbd_putc(sc, '[');
1004 genkbd_putc(sc, 'Z');
1009 /* normal chars, normal chars with the META, function keys */
1010 switch (KEYFLAGS(c)) {
1011 case 0: /* a normal char */
1012 genkbd_putc(sc, KEYCHAR(c));
1014 case MKEY: /* the META flag: prepend ESC */
1015 genkbd_putc(sc, 0x1b);
1016 genkbd_putc(sc, KEYCHAR(c));
1018 case FKEY | SPCLKEY: /* a function key, return string */
1019 cp = kbd_get_fkeystr(kbd, KEYCHAR(c), &len);
1022 genkbd_putc(sc, *cp++);
1028 /* wake up sleeping/polling processes */
1029 if (sc->gkb_q_length > 0) {
1030 if (sc->gkb_flags & KB_ASLEEP) {
1031 sc->gkb_flags &= ~KB_ASLEEP;
1032 wakeup((caddr_t)sc);
1034 KNOTE(&sc->gkb_rkq.ki_note, 0);
1037 lwkt_reltoken(&tty_token);
1041 #endif /* KBD_INSTALL_CDEV */
1044 * Generic low-level keyboard functions
1045 * The low-level functions in the keyboard subdriver may use these
1050 genkbd_commonioctl(keyboard_t *kbd, u_long cmd, caddr_t arg)
1057 lwkt_gettoken(&tty_token);
1060 case KDGKBINFO: /* get keyboard information */
1061 ((keyboard_info_t *)arg)->kb_index = kbd->kb_index;
1062 i = imin(strlen(kbd->kb_name) + 1,
1063 sizeof(((keyboard_info_t *)arg)->kb_name));
1064 bcopy(kbd->kb_name, ((keyboard_info_t *)arg)->kb_name, i);
1065 ((keyboard_info_t *)arg)->kb_unit = kbd->kb_unit;
1066 ((keyboard_info_t *)arg)->kb_type = kbd->kb_type;
1067 ((keyboard_info_t *)arg)->kb_config = kbd->kb_config;
1068 ((keyboard_info_t *)arg)->kb_flags = kbd->kb_flags;
1071 case KDGKBTYPE: /* get keyboard type */
1072 *(int *)arg = kbd->kb_type;
1075 case KDGETREPEAT: /* get keyboard repeat rate */
1076 ((int *)arg)[0] = kbd->kb_delay1;
1077 ((int *)arg)[1] = kbd->kb_delay2;
1080 case GIO_KEYMAP: /* get keyboard translation table */
1081 bcopy(kbd->kb_keymap, arg, sizeof(*kbd->kb_keymap));
1083 case PIO_KEYMAP: /* set keyboard translation table */
1084 #ifndef KBD_DISABLE_KEYMAP_LOAD
1085 bzero(kbd->kb_accentmap, sizeof(*kbd->kb_accentmap));
1086 bcopy(arg, kbd->kb_keymap, sizeof(*kbd->kb_keymap));
1089 lwkt_reltoken(&tty_token);
1094 case GIO_KEYMAPENT: /* get keyboard translation table entry */
1095 keyp = (keyarg_t *)arg;
1096 if (keyp->keynum >= sizeof(kbd->kb_keymap->key)
1097 /sizeof(kbd->kb_keymap->key[0])) {
1098 lwkt_reltoken(&tty_token);
1102 bcopy(&kbd->kb_keymap->key[keyp->keynum], &keyp->key,
1105 case PIO_KEYMAPENT: /* set keyboard translation table entry */
1106 #ifndef KBD_DISABLE_KEYMAP_LOAD
1107 keyp = (keyarg_t *)arg;
1108 if (keyp->keynum >= sizeof(kbd->kb_keymap->key)
1109 /sizeof(kbd->kb_keymap->key[0])) {
1110 lwkt_reltoken(&tty_token);
1114 bcopy(&keyp->key, &kbd->kb_keymap->key[keyp->keynum],
1118 lwkt_reltoken(&tty_token);
1123 case GIO_DEADKEYMAP: /* get accent key translation table */
1124 bcopy(kbd->kb_accentmap, arg, sizeof(*kbd->kb_accentmap));
1126 case PIO_DEADKEYMAP: /* set accent key translation table */
1127 #ifndef KBD_DISABLE_KEYMAP_LOAD
1128 bcopy(arg, kbd->kb_accentmap, sizeof(*kbd->kb_accentmap));
1131 lwkt_reltoken(&tty_token);
1136 case GETFKEY: /* get functionkey string */
1137 fkeyp = (fkeyarg_t *)arg;
1138 if (fkeyp->keynum >= kbd->kb_fkeytab_size) {
1139 lwkt_reltoken(&tty_token);
1143 bcopy(kbd->kb_fkeytab[fkeyp->keynum].str, fkeyp->keydef,
1144 kbd->kb_fkeytab[fkeyp->keynum].len);
1145 fkeyp->flen = kbd->kb_fkeytab[fkeyp->keynum].len;
1147 case SETFKEY: /* set functionkey string */
1148 #ifndef KBD_DISABLE_KEYMAP_LOAD
1149 fkeyp = (fkeyarg_t *)arg;
1150 if (fkeyp->keynum >= kbd->kb_fkeytab_size) {
1151 lwkt_reltoken(&tty_token);
1155 kbd->kb_fkeytab[fkeyp->keynum].len = imin(fkeyp->flen, MAXFK);
1156 bcopy(fkeyp->keydef, kbd->kb_fkeytab[fkeyp->keynum].str,
1157 kbd->kb_fkeytab[fkeyp->keynum].len);
1160 lwkt_reltoken(&tty_token);
1166 lwkt_reltoken(&tty_token);
1171 lwkt_reltoken(&tty_token);
1176 /* get a pointer to the string associated with the given function key */
1178 genkbd_get_fkeystr(keyboard_t *kbd, int fkey, size_t *len)
1185 lwkt_gettoken(&tty_token);
1187 if (fkey > kbd->kb_fkeytab_size) {
1188 lwkt_reltoken(&tty_token);
1191 *len = kbd->kb_fkeytab[fkey].len;
1192 ch = kbd->kb_fkeytab[fkey].str;
1194 lwkt_reltoken(&tty_token);
1198 /* diagnostic dump */
1200 get_kbd_type_name(int type)
1207 { KB_101, "AT 101/102" },
1208 { KB_OTHER, "generic" },
1212 for (i = 0; i < NELEM(name_table); ++i) {
1213 if (type == name_table[i].type)
1214 return name_table[i].name;
1220 genkbd_diag(keyboard_t *kbd, int level)
1223 kprintf("kbd%d: %s%d, %s (%d), config:0x%x, flags:0x%x",
1224 kbd->kb_index, kbd->kb_name, kbd->kb_unit,
1225 get_kbd_type_name(kbd->kb_type), kbd->kb_type,
1226 kbd->kb_config, kbd->kb_flags);
1227 if (kbd->kb_io_base > 0)
1228 kprintf(", port:0x%x-0x%x", kbd->kb_io_base,
1229 kbd->kb_io_base + kbd->kb_io_size - 1);
1234 #define set_lockkey_state(k, s, l) \
1235 if (!((s) & l ## DOWN)) { \
1239 i = (s) & LOCK_MASK; \
1240 kbd_ioctl((k), KDSETLED, (caddr_t)&i); \
1244 save_accent_key(keyboard_t *kbd, u_int key, int *accents)
1248 lwkt_gettoken(&tty_token);
1249 /* make an index into the accent map */
1250 i = key - F_ACC + 1;
1251 if ((i > kbd->kb_accentmap->n_accs)
1252 || (kbd->kb_accentmap->acc[i - 1].accchar == 0)) {
1253 /* the index is out of range or pointing to an empty entry */
1255 lwkt_reltoken(&tty_token);
1260 * If the same accent key has been hit twice, produce the accent char
1263 if (i == *accents) {
1264 key = kbd->kb_accentmap->acc[i - 1].accchar;
1266 lwkt_reltoken(&tty_token);
1270 /* remember the index and wait for the next key */
1272 lwkt_reltoken(&tty_token);
1277 make_accent_char(keyboard_t *kbd, u_int ch, int *accents)
1282 lwkt_gettoken(&tty_token);
1283 acc = &kbd->kb_accentmap->acc[*accents - 1];
1287 * If the accent key is followed by the space key,
1288 * produce the accent char itself.
1291 lwkt_reltoken(&tty_token);
1292 return acc->accchar;
1295 /* scan the accent map */
1296 for (i = 0; i < NUM_ACCENTCHARS; ++i) {
1297 if (acc->map[i][0] == 0) /* end of table */
1299 if (acc->map[i][0] == ch) {
1300 lwkt_reltoken(&tty_token);
1301 return acc->map[i][1];
1304 lwkt_reltoken(&tty_token);
1305 /* this char cannot be accented... */
1310 genkbd_keyaction(keyboard_t *kbd, int keycode, int up, int *shiftstate,
1313 struct keyent_t *key;
1314 int state = *shiftstate;
1319 lwkt_gettoken(&tty_token);
1321 f = state & (AGRS | ALKED);
1322 if ((f == AGRS1) || (f == AGRS2) || (f == ALKED))
1324 key = &kbd->kb_keymap->key[i];
1325 i = ((state & SHIFTS) ? 1 : 0)
1326 | ((state & CTLS) ? 2 : 0)
1327 | ((state & ALTS) ? 4 : 0);
1328 if (((key->flgs & FLAG_LOCK_C) && (state & CLKED))
1329 || ((key->flgs & FLAG_LOCK_N) && (state & NLKED)) )
1332 if (up) { /* break: key released */
1333 action = kbd->kb_lastact[keycode];
1334 kbd->kb_lastact[keycode] = NOP;
1337 if (state & SHIFTAON) {
1338 set_lockkey_state(kbd, state, ALK);
1347 if (state & SHIFTAON) {
1348 set_lockkey_state(kbd, state, ALK);
1357 if (state & SHIFTAON) {
1358 set_lockkey_state(kbd, state, ALK);
1367 if (state & SHIFTAON) {
1368 set_lockkey_state(kbd, state, ALK);
1377 if (state & SHIFTAON) {
1378 set_lockkey_state(kbd, state, ALK);
1387 if (state & SHIFTAON) {
1388 set_lockkey_state(kbd, state, ALK);
1415 /* release events of regular keys are not reported */
1416 *shiftstate &= ~SHIFTAON;
1417 lwkt_reltoken(&tty_token);
1420 *shiftstate = state & ~SHIFTAON;
1421 lwkt_reltoken(&tty_token);
1422 return (SPCLKEY | RELKEY | action);
1423 } else { /* make: key pressed */
1424 action = key->map[i];
1426 if (key->spcl & (0x80 >> i)) {
1428 if (kbd->kb_lastact[keycode] == NOP)
1429 kbd->kb_lastact[keycode] = action;
1430 if (kbd->kb_lastact[keycode] != action)
1435 set_lockkey_state(kbd, state, NLK);
1438 set_lockkey_state(kbd, state, CLK);
1441 set_lockkey_state(kbd, state, SLK);
1444 set_lockkey_state(kbd, state, ALK);
1446 /* NON-LOCKING KEYS */
1447 case SPSC: case RBT: case SUSP: case STBY:
1448 case DBG: case NEXT: case PREV: case PNC:
1449 case HALT: case PDWN:
1505 *shiftstate = state;
1506 lwkt_reltoken(&tty_token);
1509 /* is this an accent (dead) key? */
1510 *shiftstate = state;
1511 if (action >= F_ACC && action <= L_ACC) {
1512 action = save_accent_key(kbd, action,
1517 lwkt_reltoken(&tty_token);
1520 if (state & METAS) {
1521 lwkt_reltoken(&tty_token);
1522 return (action | MKEY);
1524 lwkt_reltoken(&tty_token);
1530 /* other special keys */
1533 lwkt_reltoken(&tty_token);
1536 if (action >= F_FN && action <= L_FN)
1538 /* XXX: return fkey string for the FKEY? */
1539 lwkt_reltoken(&tty_token);
1540 return (SPCLKEY | action);
1542 *shiftstate = state;
1543 lwkt_reltoken(&tty_token);
1544 return (SPCLKEY | action);
1547 kbd->kb_lastact[keycode] = NOP;
1548 *shiftstate = state;
1550 /* make an accented char */
1551 action = make_accent_char(kbd, action, accents);
1552 if (action == ERRKEY) {
1553 lwkt_reltoken(&tty_token);
1559 lwkt_reltoken(&tty_token);
1564 lwkt_reltoken(&tty_token);