2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
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.
30 #include <sys/cdefs.h>
31 __FBSDID("$FreeBSD$");
35 #include <sys/param.h>
36 #include <sys/systm.h>
37 #include <sys/kernel.h>
38 #include <sys/malloc.h>
40 #include <sys/fcntl.h>
44 #include <sys/selinfo.h>
45 #include <sys/sysctl.h>
50 #include <dev/evdev/input-event-codes.h>
51 #include <dev/kbd/kbdreg.h>
53 #define KBD_INDEX(dev) dev2unit(dev)
58 typedef struct genkbd_softc {
59 int gkb_flags; /* flag/status bits */
60 #define KB_ASLEEP (1 << 0)
61 struct selinfo gkb_rsel;
62 char gkb_q[KB_QSIZE]; /* input queue */
63 unsigned int gkb_q_start;
64 unsigned int gkb_q_length;
67 static u_char *genkbd_get_fkeystr(keyboard_t *kbd, int fkey, size_t *len);
68 static void genkbd_diag(keyboard_t *kbd, int level);
70 static SLIST_HEAD(, keyboard_driver) keyboard_drivers =
71 SLIST_HEAD_INITIALIZER(keyboard_drivers);
73 SET_DECLARE(kbddriver_set, keyboard_driver_t);
78 * We need at least one entry each in order to initialize a keyboard
79 * for the kernel console. The arrays will be increased dynamically
83 static int keyboards = 1;
84 static keyboard_t *kbd_ini;
85 static keyboard_t **keyboard = &kbd_ini;
87 static int keymap_restrict_change;
88 static SYSCTL_NODE(_hw, OID_AUTO, kbd, CTLFLAG_RD | CTLFLAG_MPSAFE, 0,
90 SYSCTL_INT(_hw_kbd, OID_AUTO, keymap_restrict_change, CTLFLAG_RW,
91 &keymap_restrict_change, 0, "restrict ability to change keymap");
96 kbd_realloc_array(void)
103 newsize = rounddown(keyboards + ARRAY_DELTA, ARRAY_DELTA);
104 new_kbd = malloc(sizeof(*new_kbd)*newsize, M_DEVBUF, M_NOWAIT|M_ZERO);
105 if (new_kbd == NULL) {
109 bcopy(keyboard, new_kbd, sizeof(*keyboard)*keyboards);
111 free(keyboard, M_DEVBUF);
117 printf("kbd: new array size %d\n", keyboards);
123 * Low-level keyboard driver functions
124 * Keyboard subdrivers, such as the AT keyboard driver and the USB keyboard
125 * driver, call these functions to initialize the keyboard_t structure
126 * and register it to the virtual keyboard driver `kbd'.
129 /* initialize the keyboard_t structure */
131 kbd_init_struct(keyboard_t *kbd, char *name, int type, int unit, int config,
132 int port, int port_size)
134 kbd->kb_flags = KB_NO_DEVICE; /* device has not been found */
138 kbd->kb_config = config & ~KB_CONF_PROBE_ONLY;
139 kbd->kb_led = 0; /* unknown */
140 kbd->kb_io_base = port;
141 kbd->kb_io_size = port_size;
143 kbd->kb_keymap = NULL;
144 kbd->kb_accentmap = NULL;
145 kbd->kb_fkeytab = NULL;
146 kbd->kb_fkeytab_size = 0;
147 kbd->kb_delay1 = KB_DELAY1; /* these values are advisory only */
148 kbd->kb_delay2 = KB_DELAY2;
150 bzero(kbd->kb_lastact, sizeof(kbd->kb_lastact));
154 kbd_set_maps(keyboard_t *kbd, keymap_t *keymap, accentmap_t *accmap,
155 fkeytab_t *fkeymap, int fkeymap_size)
157 kbd->kb_keymap = keymap;
158 kbd->kb_accentmap = accmap;
159 kbd->kb_fkeytab = fkeymap;
160 kbd->kb_fkeytab_size = fkeymap_size;
163 /* declare a new keyboard driver */
165 kbd_add_driver(keyboard_driver_t *driver)
168 if ((driver->flags & KBDF_REGISTERED) != 0)
171 KASSERT(SLIST_NEXT(driver, link) == NULL,
172 ("%s: keyboard driver list garbage detected", __func__));
173 if (driver->kbdsw->get_fkeystr == NULL)
174 driver->kbdsw->get_fkeystr = genkbd_get_fkeystr;
175 if (driver->kbdsw->diag == NULL)
176 driver->kbdsw->diag = genkbd_diag;
178 driver->flags |= KBDF_REGISTERED;
179 SLIST_INSERT_HEAD(&keyboard_drivers, driver, link);
184 kbd_delete_driver(keyboard_driver_t *driver)
187 if ((driver->flags & KBDF_REGISTERED) == 0)
190 driver->flags &= ~KBDF_REGISTERED;
191 SLIST_REMOVE(&keyboard_drivers, driver, keyboard_driver, link);
192 SLIST_NEXT(driver, link) = NULL;
196 /* register a keyboard and associate it with a function table */
198 kbd_register(keyboard_t *kbd)
200 const keyboard_driver_t *p;
205 mux = kbd_get_keyboard(kbd_find_keyboard("kbdmux", -1));
207 for (index = 0; index < keyboards; ++index) {
208 if (keyboard[index] == NULL)
211 if (index >= keyboards) {
212 if (kbd_realloc_array())
216 kbd->kb_index = index;
219 kbd->kb_active = 0; /* disabled until someone calls kbd_enable() */
220 kbd->kb_token = NULL;
221 kbd->kb_callback.kc_func = NULL;
222 kbd->kb_callback.kc_arg = NULL;
224 SLIST_FOREACH(p, &keyboard_drivers, link) {
225 if (strcmp(p->name, kbd->kb_name) == 0) {
227 keyboard[index] = kbd;
230 bzero(&ki, sizeof(ki));
231 strcpy(ki.kb_name, kbd->kb_name);
232 ki.kb_unit = kbd->kb_unit;
234 (void)kbdd_ioctl(mux, KBADDKBD, (caddr_t) &ki);
245 kbd_unregister(keyboard_t *kbd)
250 if ((kbd->kb_index < 0) || (kbd->kb_index >= keyboards))
252 if (keyboard[kbd->kb_index] != kbd)
256 if (KBD_IS_BUSY(kbd)) {
257 error = (*kbd->kb_callback.kc_func)(kbd, KBDIO_UNLOADING,
258 kbd->kb_callback.kc_arg);
263 if (KBD_IS_BUSY(kbd)) {
269 keyboard[kbd->kb_index] = NULL;
275 /* find a function table by the driver name */
277 kbd_get_switch(char *driver)
279 const keyboard_driver_t *p;
281 SLIST_FOREACH(p, &keyboard_drivers, link) {
282 if (strcmp(p->name, driver) == 0)
290 * Keyboard client functions
291 * Keyboard clients, such as the console driver `syscons' and the keyboard
292 * cdev driver, use these functions to claim and release a keyboard for
297 * find the keyboard specified by a driver name and a unit number
298 * starting at given index
301 kbd_find_keyboard2(char *driver, int unit, int index)
305 if ((index < 0) || (index >= keyboards))
308 for (i = index; i < keyboards; ++i) {
309 if (keyboard[i] == NULL)
311 if (!KBD_IS_VALID(keyboard[i]))
313 if (strcmp("*", driver) && strcmp(keyboard[i]->kb_name, driver))
315 if ((unit != -1) && (keyboard[i]->kb_unit != unit))
323 /* find the keyboard specified by a driver name and a unit number */
325 kbd_find_keyboard(char *driver, int unit)
327 return (kbd_find_keyboard2(driver, unit, 0));
330 /* allocate a keyboard */
332 kbd_allocate(char *driver, int unit, void *id, kbd_callback_func_t *func,
342 index = kbd_find_keyboard(driver, unit);
344 if (KBD_IS_BUSY(keyboard[index])) {
348 keyboard[index]->kb_token = id;
349 KBD_BUSY(keyboard[index]);
350 keyboard[index]->kb_callback.kc_func = func;
351 keyboard[index]->kb_callback.kc_arg = arg;
352 kbdd_clear_state(keyboard[index]);
359 kbd_release(keyboard_t *kbd, void *id)
365 if (!KBD_IS_VALID(kbd) || !KBD_IS_BUSY(kbd)) {
367 } else if (kbd->kb_token != id) {
370 kbd->kb_token = NULL;
372 kbd->kb_callback.kc_func = NULL;
373 kbd->kb_callback.kc_arg = NULL;
374 kbdd_clear_state(kbd);
382 kbd_change_callback(keyboard_t *kbd, void *id, kbd_callback_func_t *func,
389 if (!KBD_IS_VALID(kbd) || !KBD_IS_BUSY(kbd)) {
391 } else if (kbd->kb_token != id) {
393 } else if (func == NULL) {
396 kbd->kb_callback.kc_func = func;
397 kbd->kb_callback.kc_arg = arg;
404 /* get a keyboard structure */
406 kbd_get_keyboard(int index)
408 if ((index < 0) || (index >= keyboards))
410 if (keyboard[index] == NULL)
412 if (!KBD_IS_VALID(keyboard[index]))
414 return (keyboard[index]);
418 * The back door for the console driver; configure keyboards
419 * This function is for the kernel console to initialize keyboards
420 * at very early stage.
424 kbd_configure(int flags)
426 const keyboard_driver_t *p;
428 SLIST_FOREACH(p, &keyboard_drivers, link) {
429 if (p->configure != NULL)
430 (*p->configure)(flags);
436 #ifdef KBD_INSTALL_CDEV
439 * Virtual keyboard cdev driver functions
440 * The virtual keyboard driver dispatches driver functions to
441 * appropriate subdrivers.
444 #define KBD_UNIT(dev) dev2unit(dev)
446 static d_open_t genkbdopen;
447 static d_close_t genkbdclose;
448 static d_read_t genkbdread;
449 static d_write_t genkbdwrite;
450 static d_ioctl_t genkbdioctl;
451 static d_poll_t genkbdpoll;
454 static struct cdevsw kbd_cdevsw = {
455 .d_version = D_VERSION,
456 .d_flags = D_NEEDGIANT,
457 .d_open = genkbdopen,
458 .d_close = genkbdclose,
459 .d_read = genkbdread,
460 .d_write = genkbdwrite,
461 .d_ioctl = genkbdioctl,
462 .d_poll = genkbdpoll,
467 kbd_attach(keyboard_t *kbd)
470 if (kbd->kb_index >= keyboards)
472 if (keyboard[kbd->kb_index] != kbd)
475 kbd->kb_dev = make_dev(&kbd_cdevsw, kbd->kb_index, UID_ROOT, GID_WHEEL,
476 0600, "%s%r", kbd->kb_name, kbd->kb_unit);
477 make_dev_alias(kbd->kb_dev, "kbd%r", kbd->kb_index);
478 kbd->kb_dev->si_drv1 = malloc(sizeof(genkbd_softc_t), M_DEVBUF,
480 printf("kbd%d at %s%d\n", kbd->kb_index, kbd->kb_name, kbd->kb_unit);
485 kbd_detach(keyboard_t *kbd)
488 if (kbd->kb_index >= keyboards)
490 if (keyboard[kbd->kb_index] != kbd)
493 free(kbd->kb_dev->si_drv1, M_DEVBUF);
494 destroy_dev(kbd->kb_dev);
500 * Generic keyboard cdev driver functions
501 * Keyboard subdrivers may call these functions to implement common
506 genkbd_putc(genkbd_softc_t *sc, char c)
510 if (sc->gkb_q_length == KB_QSIZE)
513 p = (sc->gkb_q_start + sc->gkb_q_length) % KB_QSIZE;
519 genkbd_getc(genkbd_softc_t *sc, char *buf, size_t len)
522 /* Determine copy size. */
523 if (sc->gkb_q_length == 0)
525 if (len >= sc->gkb_q_length)
526 len = sc->gkb_q_length;
527 if (len >= KB_QSIZE - sc->gkb_q_start)
528 len = KB_QSIZE - sc->gkb_q_start;
530 /* Copy out data and progress offset. */
531 memcpy(buf, sc->gkb_q + sc->gkb_q_start, len);
532 sc->gkb_q_start = (sc->gkb_q_start + len) % KB_QSIZE;
533 sc->gkb_q_length -= len;
538 static kbd_callback_func_t genkbd_event;
541 genkbdopen(struct cdev *dev, int mode, int flag, struct thread *td)
550 kbd = kbd_get_keyboard(KBD_INDEX(dev));
551 if ((sc == NULL) || (kbd == NULL) || !KBD_IS_VALID(kbd)) {
555 i = kbd_allocate(kbd->kb_name, kbd->kb_unit, sc,
556 genkbd_event, (void *)sc);
561 /* assert(i == kbd->kb_index) */
562 /* assert(kbd == kbd_get_keyboard(i)) */
565 * NOTE: even when we have successfully claimed a keyboard,
566 * the device may still be missing (!KBD_HAS_DEVICE(kbd)).
569 sc->gkb_q_length = 0;
576 genkbdclose(struct cdev *dev, int mode, int flag, struct thread *td)
583 * NOTE: the device may have already become invalid.
584 * kbd == NULL || !KBD_IS_VALID(kbd)
588 kbd = kbd_get_keyboard(KBD_INDEX(dev));
589 if ((sc == NULL) || (kbd == NULL) || !KBD_IS_VALID(kbd)) {
590 /* XXX: we shall be forgiving and don't report error... */
592 kbd_release(kbd, (void *)sc);
599 genkbdread(struct cdev *dev, struct uio *uio, int flag)
603 u_char buffer[KB_BUFSIZE];
611 kbd = kbd_get_keyboard(KBD_INDEX(dev));
612 if ((sc == NULL) || (kbd == NULL) || !KBD_IS_VALID(kbd)) {
616 while (sc->gkb_q_length == 0) {
617 if (flag & O_NONBLOCK) {
619 return (EWOULDBLOCK);
621 sc->gkb_flags |= KB_ASLEEP;
622 error = tsleep(sc, PZERO | PCATCH, "kbdrea", 0);
623 kbd = kbd_get_keyboard(KBD_INDEX(dev));
624 if ((kbd == NULL) || !KBD_IS_VALID(kbd)) {
626 return (ENXIO); /* our keyboard has gone... */
629 sc->gkb_flags &= ~KB_ASLEEP;
636 /* copy as much input as possible */
638 while (uio->uio_resid > 0) {
639 len = imin(uio->uio_resid, sizeof(buffer));
640 len = genkbd_getc(sc, buffer, len);
643 error = uiomove(buffer, len, uio);
652 genkbdwrite(struct cdev *dev, struct uio *uio, int flag)
656 kbd = kbd_get_keyboard(KBD_INDEX(dev));
657 if ((kbd == NULL) || !KBD_IS_VALID(kbd))
663 genkbdioctl(struct cdev *dev, u_long cmd, caddr_t arg, int flag, struct thread *td)
668 kbd = kbd_get_keyboard(KBD_INDEX(dev));
669 if ((kbd == NULL) || !KBD_IS_VALID(kbd))
671 error = kbdd_ioctl(kbd, cmd, arg);
672 if (error == ENOIOCTL)
678 genkbdpoll(struct cdev *dev, int events, struct thread *td)
688 kbd = kbd_get_keyboard(KBD_INDEX(dev));
689 if ((sc == NULL) || (kbd == NULL) || !KBD_IS_VALID(kbd)) {
690 revents = POLLHUP; /* the keyboard has gone */
691 } else if (events & (POLLIN | POLLRDNORM)) {
692 if (sc->gkb_q_length > 0)
693 revents = events & (POLLIN | POLLRDNORM);
695 selrecord(td, &sc->gkb_rsel);
702 genkbd_event(keyboard_t *kbd, int event, void *arg)
710 /* assert(KBD_IS_VALID(kbd)) */
711 sc = (genkbd_softc_t *)arg;
716 case KBDIO_UNLOADING:
717 /* the keyboard is going... */
718 kbd_release(kbd, (void *)sc);
719 if (sc->gkb_flags & KB_ASLEEP) {
720 sc->gkb_flags &= ~KB_ASLEEP;
723 selwakeuppri(&sc->gkb_rsel, PZERO);
729 /* obtain the current key input mode */
730 if (kbdd_ioctl(kbd, KDGKBMODE, (caddr_t)&mode))
733 /* read all pending input */
734 while (kbdd_check_char(kbd)) {
735 c = kbdd_read_char(kbd, FALSE);
738 if (c == ERRKEY) /* XXX: ring bell? */
740 if (!KBD_IS_BUSY(kbd))
741 /* the device is not open, discard the input */
744 /* store the byte as is for K_RAW and K_CODE modes */
745 if (mode != K_XLATE) {
746 genkbd_putc(sc, KEYCHAR(c));
751 if (c & RELKEY) /* key release is ignored */
754 /* process special keys; most of them are just ignored... */
756 switch (KEYCHAR(c)) {
760 case BTAB: /* a backtab: ESC [ Z */
761 genkbd_putc(sc, 0x1b);
762 genkbd_putc(sc, '[');
763 genkbd_putc(sc, 'Z');
768 /* normal chars, normal chars with the META, function keys */
769 switch (KEYFLAGS(c)) {
770 case 0: /* a normal char */
771 genkbd_putc(sc, KEYCHAR(c));
773 case MKEY: /* the META flag: prepend ESC */
774 genkbd_putc(sc, 0x1b);
775 genkbd_putc(sc, KEYCHAR(c));
777 case FKEY | SPCLKEY: /* a function key, return string */
778 cp = kbdd_get_fkeystr(kbd, KEYCHAR(c), &len);
781 genkbd_putc(sc, *cp++);
787 /* wake up sleeping/polling processes */
788 if (sc->gkb_q_length > 0) {
789 if (sc->gkb_flags & KB_ASLEEP) {
790 sc->gkb_flags &= ~KB_ASLEEP;
793 selwakeuppri(&sc->gkb_rsel, PZERO);
799 #endif /* KBD_INSTALL_CDEV */
802 * Generic low-level keyboard functions
803 * The low-level functions in the keyboard subdriver may use these
807 #ifndef KBD_DISABLE_KEYMAP_LOAD
808 static int key_change_ok(struct keyent_t *, struct keyent_t *, struct thread *);
809 static int keymap_change_ok(keymap_t *, keymap_t *, struct thread *);
810 static int accent_change_ok(accentmap_t *, accentmap_t *, struct thread *);
811 static int fkey_change_ok(fkeytab_t *, fkeyarg_t *, struct thread *);
815 genkbd_commonioctl(keyboard_t *kbd, u_long cmd, caddr_t arg)
828 case KDGKBINFO: /* get keyboard information */
829 ((keyboard_info_t *)arg)->kb_index = kbd->kb_index;
830 i = imin(strlen(kbd->kb_name) + 1,
831 sizeof(((keyboard_info_t *)arg)->kb_name));
832 bcopy(kbd->kb_name, ((keyboard_info_t *)arg)->kb_name, i);
833 ((keyboard_info_t *)arg)->kb_unit = kbd->kb_unit;
834 ((keyboard_info_t *)arg)->kb_type = kbd->kb_type;
835 ((keyboard_info_t *)arg)->kb_config = kbd->kb_config;
836 ((keyboard_info_t *)arg)->kb_flags = kbd->kb_flags;
839 case KDGKBTYPE: /* get keyboard type */
840 *(int *)arg = kbd->kb_type;
843 case KDGETREPEAT: /* get keyboard repeat rate */
844 ((int *)arg)[0] = kbd->kb_delay1;
845 ((int *)arg)[1] = kbd->kb_delay2;
848 case GIO_KEYMAP: /* get keyboard translation table */
849 error = copyout(kbd->kb_keymap, *(void **)arg,
853 case OGIO_KEYMAP: /* get keyboard translation table (compat) */
854 mapp = kbd->kb_keymap;
855 omapp = (okeymap_t *)arg;
856 omapp->n_keys = mapp->n_keys;
857 for (i = 0; i < NUM_KEYS; i++) {
858 for (j = 0; j < NUM_STATES; j++)
859 omapp->key[i].map[j] =
861 omapp->key[i].spcl = mapp->key[i].spcl;
862 omapp->key[i].flgs = mapp->key[i].flgs;
865 case PIO_KEYMAP: /* set keyboard translation table */
866 case OPIO_KEYMAP: /* set keyboard translation table (compat) */
867 #ifndef KBD_DISABLE_KEYMAP_LOAD
868 mapp = malloc(sizeof *mapp, M_TEMP, M_WAITOK);
869 if (cmd == OPIO_KEYMAP) {
870 omapp = (okeymap_t *)arg;
871 mapp->n_keys = omapp->n_keys;
872 for (i = 0; i < NUM_KEYS; i++) {
873 for (j = 0; j < NUM_STATES; j++)
874 mapp->key[i].map[j] =
875 omapp->key[i].map[j];
876 mapp->key[i].spcl = omapp->key[i].spcl;
877 mapp->key[i].flgs = omapp->key[i].flgs;
880 error = copyin(*(void **)arg, mapp, sizeof *mapp);
888 error = keymap_change_ok(kbd->kb_keymap, mapp, curthread);
894 bzero(kbd->kb_accentmap, sizeof(*kbd->kb_accentmap));
895 bcopy(mapp, kbd->kb_keymap, sizeof(*kbd->kb_keymap));
903 case GIO_KEYMAPENT: /* get keyboard translation table entry */
904 keyp = (keyarg_t *)arg;
905 if (keyp->keynum >= sizeof(kbd->kb_keymap->key) /
906 sizeof(kbd->kb_keymap->key[0])) {
910 bcopy(&kbd->kb_keymap->key[keyp->keynum], &keyp->key,
913 case PIO_KEYMAPENT: /* set keyboard translation table entry */
914 #ifndef KBD_DISABLE_KEYMAP_LOAD
915 keyp = (keyarg_t *)arg;
916 if (keyp->keynum >= sizeof(kbd->kb_keymap->key) /
917 sizeof(kbd->kb_keymap->key[0])) {
921 error = key_change_ok(&kbd->kb_keymap->key[keyp->keynum],
922 &keyp->key, curthread);
927 bcopy(&keyp->key, &kbd->kb_keymap->key[keyp->keynum],
935 case GIO_DEADKEYMAP: /* get accent key translation table */
936 bcopy(kbd->kb_accentmap, arg, sizeof(*kbd->kb_accentmap));
938 case PIO_DEADKEYMAP: /* set accent key translation table */
939 #ifndef KBD_DISABLE_KEYMAP_LOAD
940 error = accent_change_ok(kbd->kb_accentmap,
941 (accentmap_t *)arg, curthread);
946 bcopy(arg, kbd->kb_accentmap, sizeof(*kbd->kb_accentmap));
953 case GETFKEY: /* get functionkey string */
954 fkeyp = (fkeyarg_t *)arg;
955 if (fkeyp->keynum >= kbd->kb_fkeytab_size) {
959 bcopy(kbd->kb_fkeytab[fkeyp->keynum].str, fkeyp->keydef,
960 kbd->kb_fkeytab[fkeyp->keynum].len);
961 fkeyp->flen = kbd->kb_fkeytab[fkeyp->keynum].len;
963 case SETFKEY: /* set functionkey string */
964 #ifndef KBD_DISABLE_KEYMAP_LOAD
965 fkeyp = (fkeyarg_t *)arg;
966 if (fkeyp->keynum >= kbd->kb_fkeytab_size) {
970 error = fkey_change_ok(&kbd->kb_fkeytab[fkeyp->keynum],
976 kbd->kb_fkeytab[fkeyp->keynum].len = min(fkeyp->flen, MAXFK);
977 bcopy(fkeyp->keydef, kbd->kb_fkeytab[fkeyp->keynum].str,
978 kbd->kb_fkeytab[fkeyp->keynum].len);
994 #ifndef KBD_DISABLE_KEYMAP_LOAD
995 #define RESTRICTED_KEY(key, i) \
996 ((key->spcl & (0x80 >> i)) && \
997 (key->map[i] == RBT || key->map[i] == SUSP || \
998 key->map[i] == STBY || key->map[i] == DBG || \
999 key->map[i] == PNC || key->map[i] == HALT || \
1000 key->map[i] == PDWN))
1003 key_change_ok(struct keyent_t *oldkey, struct keyent_t *newkey, struct thread *td)
1007 /* Low keymap_restrict_change means any changes are OK. */
1008 if (keymap_restrict_change <= 0)
1011 /* High keymap_restrict_change means only root can change the keymap. */
1012 if (keymap_restrict_change >= 2) {
1013 for (i = 0; i < NUM_STATES; i++)
1014 if (oldkey->map[i] != newkey->map[i])
1015 return priv_check(td, PRIV_KEYBOARD);
1016 if (oldkey->spcl != newkey->spcl)
1017 return priv_check(td, PRIV_KEYBOARD);
1018 if (oldkey->flgs != newkey->flgs)
1019 return priv_check(td, PRIV_KEYBOARD);
1023 /* Otherwise we have to see if any special keys are being changed. */
1024 for (i = 0; i < NUM_STATES; i++) {
1026 * If either the oldkey or the newkey action is restricted
1027 * then we must make sure that the action doesn't change.
1029 if (!RESTRICTED_KEY(oldkey, i) && !RESTRICTED_KEY(newkey, i))
1031 if ((oldkey->spcl & (0x80 >> i)) == (newkey->spcl & (0x80 >> i))
1032 && oldkey->map[i] == newkey->map[i])
1034 return priv_check(td, PRIV_KEYBOARD);
1041 keymap_change_ok(keymap_t *oldmap, keymap_t *newmap, struct thread *td)
1045 for (keycode = 0; keycode < NUM_KEYS; keycode++) {
1046 if ((error = key_change_ok(&oldmap->key[keycode],
1047 &newmap->key[keycode], td)) != 0)
1054 accent_change_ok(accentmap_t *oldmap, accentmap_t *newmap, struct thread *td)
1056 struct acc_t *oldacc, *newacc;
1059 if (keymap_restrict_change <= 2)
1062 if (oldmap->n_accs != newmap->n_accs)
1063 return priv_check(td, PRIV_KEYBOARD);
1065 for (accent = 0; accent < oldmap->n_accs; accent++) {
1066 oldacc = &oldmap->acc[accent];
1067 newacc = &newmap->acc[accent];
1068 if (oldacc->accchar != newacc->accchar)
1069 return priv_check(td, PRIV_KEYBOARD);
1070 for (i = 0; i < NUM_ACCENTCHARS; ++i) {
1071 if (oldacc->map[i][0] != newacc->map[i][0])
1072 return priv_check(td, PRIV_KEYBOARD);
1073 if (oldacc->map[i][0] == 0) /* end of table */
1075 if (oldacc->map[i][1] != newacc->map[i][1])
1076 return priv_check(td, PRIV_KEYBOARD);
1084 fkey_change_ok(fkeytab_t *oldkey, fkeyarg_t *newkey, struct thread *td)
1086 if (keymap_restrict_change <= 3)
1089 if (oldkey->len != newkey->flen ||
1090 bcmp(oldkey->str, newkey->keydef, oldkey->len) != 0)
1091 return priv_check(td, PRIV_KEYBOARD);
1097 /* get a pointer to the string associated with the given function key */
1099 genkbd_get_fkeystr(keyboard_t *kbd, int fkey, size_t *len)
1104 if (fkey > kbd->kb_fkeytab_size)
1106 *len = kbd->kb_fkeytab[fkey].len;
1107 return (kbd->kb_fkeytab[fkey].str);
1110 /* diagnostic dump */
1112 get_kbd_type_name(int type)
1119 { KB_101, "AT 101/102" },
1120 { KB_OTHER, "generic" },
1124 for (i = 0; i < nitems(name_table); ++i) {
1125 if (type == name_table[i].type)
1126 return (name_table[i].name);
1132 genkbd_diag(keyboard_t *kbd, int level)
1135 printf("kbd%d: %s%d, %s (%d), config:0x%x, flags:0x%x",
1136 kbd->kb_index, kbd->kb_name, kbd->kb_unit,
1137 get_kbd_type_name(kbd->kb_type), kbd->kb_type,
1138 kbd->kb_config, kbd->kb_flags);
1139 if (kbd->kb_io_base > 0)
1140 printf(", port:0x%x-0x%x", kbd->kb_io_base,
1141 kbd->kb_io_base + kbd->kb_io_size - 1);
1146 #define set_lockkey_state(k, s, l) \
1147 if (!((s) & l ## DOWN)) { \
1151 i = (s) & LOCK_MASK; \
1152 (void)kbdd_ioctl((k), KDSETLED, (caddr_t)&i); \
1156 save_accent_key(keyboard_t *kbd, u_int key, int *accents)
1160 /* make an index into the accent map */
1161 i = key - F_ACC + 1;
1162 if ((i > kbd->kb_accentmap->n_accs)
1163 || (kbd->kb_accentmap->acc[i - 1].accchar == 0)) {
1164 /* the index is out of range or pointing to an empty entry */
1170 * If the same accent key has been hit twice, produce the accent
1173 if (i == *accents) {
1174 key = kbd->kb_accentmap->acc[i - 1].accchar;
1179 /* remember the index and wait for the next key */
1185 make_accent_char(keyboard_t *kbd, u_int ch, int *accents)
1190 acc = &kbd->kb_accentmap->acc[*accents - 1];
1194 * If the accent key is followed by the space key,
1195 * produce the accent char itself.
1198 return (acc->accchar);
1200 /* scan the accent map */
1201 for (i = 0; i < NUM_ACCENTCHARS; ++i) {
1202 if (acc->map[i][0] == 0) /* end of table */
1204 if (acc->map[i][0] == ch)
1205 return (acc->map[i][1]);
1207 /* this char cannot be accented... */
1212 genkbd_keyaction(keyboard_t *kbd, int keycode, int up, int *shiftstate,
1215 struct keyent_t *key;
1216 int state = *shiftstate;
1222 f = state & (AGRS | ALKED);
1223 if ((f == AGRS1) || (f == AGRS2) || (f == ALKED))
1225 key = &kbd->kb_keymap->key[i];
1226 i = ((state & SHIFTS) ? 1 : 0)
1227 | ((state & CTLS) ? 2 : 0)
1228 | ((state & ALTS) ? 4 : 0);
1229 if (((key->flgs & FLAG_LOCK_C) && (state & CLKED))
1230 || ((key->flgs & FLAG_LOCK_N) && (state & NLKED)) )
1233 if (up) { /* break: key released */
1234 action = kbd->kb_lastact[keycode];
1235 kbd->kb_lastact[keycode] = NOP;
1238 if (state & SHIFTAON) {
1239 set_lockkey_state(kbd, state, ALK);
1248 if (state & SHIFTAON) {
1249 set_lockkey_state(kbd, state, ALK);
1258 if (state & SHIFTAON) {
1259 set_lockkey_state(kbd, state, ALK);
1268 if (state & SHIFTAON) {
1269 set_lockkey_state(kbd, state, ALK);
1278 if (state & SHIFTAON) {
1279 set_lockkey_state(kbd, state, ALK);
1288 if (state & SHIFTAON) {
1289 set_lockkey_state(kbd, state, ALK);
1316 /* release events of regular keys are not reported */
1317 *shiftstate &= ~SHIFTAON;
1320 *shiftstate = state & ~SHIFTAON;
1321 return (SPCLKEY | RELKEY | action);
1322 } else { /* make: key pressed */
1323 action = key->map[i];
1325 if (key->spcl & (0x80 >> i)) {
1327 if (kbd->kb_lastact[keycode] == NOP)
1328 kbd->kb_lastact[keycode] = action;
1329 if (kbd->kb_lastact[keycode] != action)
1334 set_lockkey_state(kbd, state, NLK);
1337 set_lockkey_state(kbd, state, CLK);
1340 set_lockkey_state(kbd, state, SLK);
1343 set_lockkey_state(kbd, state, ALK);
1345 /* NON-LOCKING KEYS */
1346 case SPSC: case RBT: case SUSP: case STBY:
1347 case DBG: case NEXT: case PREV: case PNC:
1348 case HALT: case PDWN:
1404 *shiftstate = state;
1407 /* is this an accent (dead) key? */
1408 *shiftstate = state;
1409 if (action >= F_ACC && action <= L_ACC) {
1410 action = save_accent_key(kbd, action,
1418 return (action | MKEY);
1424 /* other special keys */
1429 if (action >= F_FN && action <= L_FN)
1431 /* XXX: return fkey string for the FKEY? */
1432 return (SPCLKEY | action);
1434 *shiftstate = state;
1435 return (SPCLKEY | action);
1438 kbd->kb_lastact[keycode] = NOP;
1439 *shiftstate = state;
1441 /* make an accented char */
1442 action = make_accent_char(kbd, action, accents);
1443 if (action == ERRKEY)
1455 kbd_ev_event(keyboard_t *kbd, uint16_t type, uint16_t code, int32_t value)
1457 int delay[2], led = 0, leds, oleds;
1459 if (type == EV_LED) {
1460 leds = oleds = KBD_LED_VAL(kbd);
1479 kbdd_ioctl(kbd, KDSETLED, (caddr_t)&leds);
1481 } else if (type == EV_REP && code == REP_DELAY) {
1483 delay[1] = kbd->kb_delay2;
1484 kbdd_ioctl(kbd, KDSETREPEAT, (caddr_t)delay);
1485 } else if (type == EV_REP && code == REP_PERIOD) {
1486 delay[0] = kbd->kb_delay1;
1488 kbdd_ioctl(kbd, KDSETREPEAT, (caddr_t)delay);
1495 keyboard_driver_t *drv, **list;
1497 SET_FOREACH(list, kbddriver_set) {
1501 * The following printfs will almost universally get dropped,
1502 * with exception to kernel configs with EARLY_PRINTF and
1503 * special setups where msgbufinit() is called early with a
1504 * static buffer to capture output occurring before the dynamic
1505 * message buffer is mapped.
1507 if (kbd_add_driver(drv) != 0)
1508 printf("kbd: failed to register driver '%s'\n",
1510 else if (bootverbose)
1511 printf("kbd: registered driver '%s'\n",