6 * Copyright (c) 2004 Maksim Yevmenkin <m_evmenkin@yahoo.com>
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 * $Id: vkbd.c,v 1.20 2004/11/15 23:53:30 max Exp $
34 #include "opt_compat.h"
37 #include <sys/param.h>
39 #include <sys/fcntl.h>
41 #include <sys/kernel.h>
42 #include <sys/limits.h>
44 #include <sys/malloc.h>
45 #include <sys/module.h>
46 #include <sys/mutex.h>
49 #include <sys/queue.h>
50 #include <sys/selinfo.h>
51 #include <sys/systm.h>
52 #include <sys/taskqueue.h>
54 #include <dev/kbd/kbdreg.h>
55 #include <dev/kbd/kbdtables.h>
56 #include <dev/vkbd/vkbd_var.h>
58 #define DEVICE_NAME "vkbdctl"
59 #define KEYBOARD_NAME "vkbd"
61 MALLOC_DECLARE(M_VKBD);
62 MALLOC_DEFINE(M_VKBD, KEYBOARD_NAME, "Virtual AT keyboard");
64 /*****************************************************************************
65 *****************************************************************************
67 *****************************************************************************
68 *****************************************************************************/
72 * For now rely on Giant mutex to protect our data structures.
73 * Just like the rest of keyboard drivers and syscons(4) do.
77 #define VKBD_LOCK_DECL struct mtx ks_lock
78 #define VKBD_LOCK_INIT(s) mtx_init(&(s)->ks_lock, "vkbd_lock", NULL, MTX_DEF|MTX_RECURSE)
79 #define VKBD_LOCK_DESTROY(s) mtx_destroy(&(s)->ks_lock)
80 #define VKBD_LOCK(s) mtx_lock(&(s)->ks_lock)
81 #define VKBD_UNLOCK(s) mtx_unlock(&(s)->ks_lock)
82 #define VKBD_LOCK_ASSERT(s, w) mtx_assert(&(s)->ks_lock, w)
83 #define VKBD_SLEEP(s, f, d, t) \
84 msleep(&(s)->f, &(s)->ks_lock, PCATCH | (PZERO + 1), d, t)
86 #define VKBD_LOCK_DECL
87 #define VKBD_LOCK_INIT(s)
88 #define VKBD_LOCK_DESTROY(s)
90 #define VKBD_UNLOCK(s)
91 #define VKBD_LOCK_ASSERT(s, w)
92 #define VKBD_SLEEP(s, f, d, t) tsleep(&(s)->f, PCATCH | (PZERO + 1), d, t)
95 #define VKBD_KEYBOARD(d) \
96 kbd_get_keyboard(kbd_find_keyboard(KEYBOARD_NAME, dev2unit(d)))
101 int q[VKBD_Q_SIZE]; /* queue */
102 int head; /* index of the first code */
103 int tail; /* index of the last code */
104 int cc; /* number of codes in queue */
107 typedef struct vkbd_queue vkbd_queue_t;
112 struct cdev *ks_dev; /* control device */
114 struct selinfo ks_rsel; /* select(2) */
115 struct selinfo ks_wsel;
117 vkbd_queue_t ks_inq; /* input key codes queue */
118 struct task ks_task; /* interrupt task */
120 int ks_flags; /* flags */
121 #define OPEN (1 << 0) /* control device is open */
122 #define COMPOSE (1 << 1) /* compose flag */
123 #define STATUS (1 << 2) /* status has changed */
124 #define TASK (1 << 3) /* interrupt task queued */
125 #define READ (1 << 4) /* read pending */
126 #define WRITE (1 << 5) /* write pending */
128 int ks_mode; /* K_XLATE, K_RAW, K_CODE */
129 int ks_polling; /* polling flag */
130 int ks_state; /* shift/lock key state */
131 int ks_accents; /* accent key index (> 0) */
132 u_int ks_composed_char; /* composed char code */
133 u_char ks_prefix; /* AT scan code prefix */
138 typedef struct vkbd_state vkbd_state_t;
140 /*****************************************************************************
141 *****************************************************************************
143 *****************************************************************************
144 *****************************************************************************/
146 static void vkbd_dev_clone(void *, struct ucred *, char *, int,
148 static d_open_t vkbd_dev_open;
149 static d_close_t vkbd_dev_close;
150 static d_read_t vkbd_dev_read;
151 static d_write_t vkbd_dev_write;
152 static d_ioctl_t vkbd_dev_ioctl;
153 static d_poll_t vkbd_dev_poll;
154 static void vkbd_dev_intr(void *, int);
155 static void vkbd_status_changed(vkbd_state_t *);
156 static int vkbd_data_ready(vkbd_state_t *);
157 static int vkbd_data_read(vkbd_state_t *, int);
159 static struct cdevsw vkbd_dev_cdevsw = {
160 .d_version = D_VERSION,
161 .d_flags = D_PSEUDO | D_NEEDGIANT | D_NEEDMINOR,
162 .d_open = vkbd_dev_open,
163 .d_close = vkbd_dev_close,
164 .d_read = vkbd_dev_read,
165 .d_write = vkbd_dev_write,
166 .d_ioctl = vkbd_dev_ioctl,
167 .d_poll = vkbd_dev_poll,
168 .d_name = DEVICE_NAME,
171 static struct clonedevs *vkbd_dev_clones = NULL;
175 vkbd_dev_clone(void *arg, struct ucred *cred, char *name, int namelen,
183 if (strcmp(name, DEVICE_NAME) == 0)
185 else if (dev_stdclone(name, NULL, DEVICE_NAME, &unit) != 1)
186 return; /* don't recognize the name */
188 /* find any existing device, or allocate new unit number */
189 if (clone_create(&vkbd_dev_clones, &vkbd_dev_cdevsw, &unit, dev, 0)) {
190 *dev = make_dev(&vkbd_dev_cdevsw, unit,
191 UID_ROOT, GID_WHEEL, 0600, DEVICE_NAME "%d", unit);
194 (*dev)->si_flags |= SI_CHEAPCLONE;
201 vkbd_dev_open(struct cdev *dev, int flag, int mode, struct thread *td)
203 int unit = dev2unit(dev), error;
204 keyboard_switch_t *sw = NULL;
205 keyboard_t *kbd = NULL;
206 vkbd_state_t *state = (vkbd_state_t *) dev->si_drv1;
208 /* XXX FIXME: dev->si_drv1 locking */
210 if ((sw = kbd_get_switch(KEYBOARD_NAME)) == NULL)
213 if ((error = (*sw->probe)(unit, NULL, 0)) != 0 ||
214 (error = (*sw->init)(unit, &kbd, NULL, 0)) != 0)
217 state = (vkbd_state_t *) kbd->kb_data;
219 if ((error = (*sw->enable)(kbd)) != 0) {
224 #ifdef KBD_INSTALL_CDEV
225 if ((error = kbd_attach(kbd)) != 0) {
230 #endif /* def KBD_INSTALL_CDEV */
232 dev->si_drv1 = kbd->kb_data;
237 if (state->ks_flags & OPEN) {
242 state->ks_flags |= OPEN;
252 vkbd_dev_close(struct cdev *dev, int foo, int bar, struct thread *td)
254 keyboard_t *kbd = VKBD_KEYBOARD(dev);
255 vkbd_state_t *state = NULL;
260 if (kbd->kb_data == NULL || kbd->kb_data != dev->si_drv1)
261 panic("%s: kbd->kb_data != dev->si_drv1\n", __func__);
263 state = (vkbd_state_t *) kbd->kb_data;
267 /* wait for interrupt task */
268 while (state->ks_flags & TASK)
269 VKBD_SLEEP(state, ks_task, "vkbdc", 0);
271 /* wakeup poll()ers */
272 selwakeuppri(&state->ks_rsel, PZERO + 1);
273 selwakeuppri(&state->ks_wsel, PZERO + 1);
275 state->ks_flags &= ~OPEN;
276 state->ks_dev = NULL;
277 state->ks_inq.head = state->ks_inq.tail = state->ks_inq.cc = 0;
282 #ifdef KBD_INSTALL_CDEV
284 #endif /* def KBD_INSTALL_CDEV */
287 /* XXX FIXME: dev->si_drv1 locking */
295 vkbd_dev_read(struct cdev *dev, struct uio *uio, int flag)
297 keyboard_t *kbd = VKBD_KEYBOARD(dev);
298 vkbd_state_t *state = NULL;
299 vkbd_status_t status;
305 if (uio->uio_resid != sizeof(status))
308 if (kbd->kb_data == NULL || kbd->kb_data != dev->si_drv1)
309 panic("%s: kbd->kb_data != dev->si_drv1\n", __func__);
311 state = (vkbd_state_t *) kbd->kb_data;
315 if (state->ks_flags & READ) {
320 state->ks_flags |= READ;
322 if (state->ks_flags & STATUS) {
323 state->ks_flags &= ~STATUS;
325 status.mode = state->ks_mode;
326 status.leds = KBD_LED_VAL(kbd);
327 status.lock = state->ks_state & LOCK_MASK;
328 status.delay = kbd->kb_delay1;
329 status.rate = kbd->kb_delay2;
330 bzero(status.reserved, sizeof(status.reserved));
332 error = uiomove(&status, sizeof(status), uio);
334 if (flag & O_NONBLOCK) {
339 error = VKBD_SLEEP(state, ks_flags, "vkbdr", 0);
346 state->ks_flags &= ~READ;
353 /* Write scancodes */
355 vkbd_dev_write(struct cdev *dev, struct uio *uio, int flag)
357 keyboard_t *kbd = VKBD_KEYBOARD(dev);
358 vkbd_state_t *state = NULL;
359 vkbd_queue_t *q = NULL;
360 int error, avail, bytes;
365 if (uio->uio_resid <= 0)
368 if (kbd->kb_data == NULL || kbd->kb_data != dev->si_drv1)
369 panic("%s: kbd->kb_data != dev->si_drv1\n", __func__);
371 state = (vkbd_state_t *) kbd->kb_data;
375 if (state->ks_flags & WRITE) {
380 state->ks_flags |= WRITE;
384 while (uio->uio_resid >= sizeof(q->q[0])) {
385 if (q->head == q->tail) {
387 avail = sizeof(q->q)/sizeof(q->q[0]) - q->head;
389 avail = 0; /* queue must be full */
390 } else if (q->head < q->tail)
391 avail = sizeof(q->q)/sizeof(q->q[0]) - q->tail;
393 avail = q->head - q->tail;
396 if (flag & O_NONBLOCK) {
401 error = VKBD_SLEEP(state, ks_inq, "vkbdw", 0);
405 bytes = avail * sizeof(q->q[0]);
406 if (bytes > uio->uio_resid) {
407 avail = uio->uio_resid / sizeof(q->q[0]);
408 bytes = avail * sizeof(q->q[0]);
411 error = uiomove((void *) &q->q[q->tail], bytes, uio);
417 if (q->tail == sizeof(q->q)/sizeof(q->q[0]))
420 /* queue interrupt task if needed */
421 if (!(state->ks_flags & TASK) &&
422 taskqueue_enqueue(taskqueue_swi_giant, &state->ks_task) == 0)
423 state->ks_flags |= TASK;
427 state->ks_flags &= ~WRITE;
436 vkbd_dev_ioctl(struct cdev *dev, u_long cmd, caddr_t data, int flag, struct thread *td)
438 keyboard_t *kbd = VKBD_KEYBOARD(dev);
440 return ((kbd == NULL)? ENXIO : kbdd_ioctl(kbd, cmd, data));
445 vkbd_dev_poll(struct cdev *dev, int events, struct thread *td)
447 vkbd_state_t *state = (vkbd_state_t *) dev->si_drv1;
448 vkbd_queue_t *q = NULL;
458 if (events & (POLLIN | POLLRDNORM)) {
459 if (state->ks_flags & STATUS)
460 revents |= events & (POLLIN | POLLRDNORM);
462 selrecord(td, &state->ks_rsel);
465 if (events & (POLLOUT | POLLWRNORM)) {
466 if (q->cc < sizeof(q->q)/sizeof(q->q[0]))
467 revents |= events & (POLLOUT | POLLWRNORM);
469 selrecord(td, &state->ks_wsel);
477 /* Interrupt handler */
479 vkbd_dev_intr(void *xkbd, int pending)
481 keyboard_t *kbd = (keyboard_t *) xkbd;
482 vkbd_state_t *state = (vkbd_state_t *) kbd->kb_data;
484 kbdd_intr(kbd, NULL);
488 state->ks_flags &= ~TASK;
489 wakeup(&state->ks_task);
494 /* Set status change flags */
496 vkbd_status_changed(vkbd_state_t *state)
498 VKBD_LOCK_ASSERT(state, MA_OWNED);
500 if (!(state->ks_flags & STATUS)) {
501 state->ks_flags |= STATUS;
502 selwakeuppri(&state->ks_rsel, PZERO + 1);
503 wakeup(&state->ks_flags);
507 /* Check if we have data in the input queue */
509 vkbd_data_ready(vkbd_state_t *state)
511 VKBD_LOCK_ASSERT(state, MA_OWNED);
513 return (state->ks_inq.cc > 0);
516 /* Read one code from the input queue */
518 vkbd_data_read(vkbd_state_t *state, int wait)
520 vkbd_queue_t *q = &state->ks_inq;
523 VKBD_LOCK_ASSERT(state, MA_OWNED);
528 /* get first code from the queue */
530 c = q->q[q->head ++];
531 if (q->head == sizeof(q->q)/sizeof(q->q[0]))
534 /* wakeup ks_inq writers/poll()ers */
535 selwakeuppri(&state->ks_wsel, PZERO + 1);
541 /****************************************************************************
542 ****************************************************************************
544 ****************************************************************************
545 ****************************************************************************/
547 static int vkbd_configure(int flags);
548 static kbd_probe_t vkbd_probe;
549 static kbd_init_t vkbd_init;
550 static kbd_term_t vkbd_term;
551 static kbd_intr_t vkbd_intr;
552 static kbd_test_if_t vkbd_test_if;
553 static kbd_enable_t vkbd_enable;
554 static kbd_disable_t vkbd_disable;
555 static kbd_read_t vkbd_read;
556 static kbd_check_t vkbd_check;
557 static kbd_read_char_t vkbd_read_char;
558 static kbd_check_char_t vkbd_check_char;
559 static kbd_ioctl_t vkbd_ioctl;
560 static kbd_lock_t vkbd_lock;
561 static void vkbd_clear_state_locked(vkbd_state_t *state);
562 static kbd_clear_state_t vkbd_clear_state;
563 static kbd_get_state_t vkbd_get_state;
564 static kbd_set_state_t vkbd_set_state;
565 static kbd_poll_mode_t vkbd_poll;
567 static keyboard_switch_t vkbdsw = {
572 .test_if = vkbd_test_if,
573 .enable = vkbd_enable,
574 .disable = vkbd_disable,
577 .read_char = vkbd_read_char,
578 .check_char = vkbd_check_char,
581 .clear_state = vkbd_clear_state,
582 .get_state = vkbd_get_state,
583 .set_state = vkbd_set_state,
584 .get_fkeystr = genkbd_get_fkeystr,
589 static int typematic(int delay, int rate);
590 static int typematic_delay(int delay);
591 static int typematic_rate(int rate);
593 /* Return the number of found keyboards */
595 vkbd_configure(int flags)
600 /* Detect a keyboard */
602 vkbd_probe(int unit, void *arg, int flags)
607 /* Reset and initialize the keyboard (stolen from atkbd.c) */
609 vkbd_init(int unit, keyboard_t **kbdp, void *arg, int flags)
611 keyboard_t *kbd = NULL;
612 vkbd_state_t *state = NULL;
613 keymap_t *keymap = NULL;
614 accentmap_t *accmap = NULL;
615 fkeytab_t *fkeymap = NULL;
616 int fkeymap_size, delay[2];
620 *kbdp = kbd = malloc(sizeof(*kbd), M_VKBD, M_NOWAIT | M_ZERO);
621 state = malloc(sizeof(*state), M_VKBD, M_NOWAIT | M_ZERO);
622 keymap = malloc(sizeof(key_map), M_VKBD, M_NOWAIT);
623 accmap = malloc(sizeof(accent_map), M_VKBD, M_NOWAIT);
624 fkeymap = malloc(sizeof(fkey_tab), M_VKBD, M_NOWAIT);
625 fkeymap_size = sizeof(fkey_tab)/sizeof(fkey_tab[0]);
627 if ((kbd == NULL) || (state == NULL) || (keymap == NULL) ||
628 (accmap == NULL) || (fkeymap == NULL)) {
633 VKBD_LOCK_INIT(state);
634 state->ks_inq.head = state->ks_inq.tail = state->ks_inq.cc = 0;
635 TASK_INIT(&state->ks_task, 0, vkbd_dev_intr, (void *) kbd);
636 } else if (KBD_IS_INITIALIZED(*kbdp) && KBD_IS_CONFIGURED(*kbdp)) {
640 state = (vkbd_state_t *) kbd->kb_data;
641 keymap = kbd->kb_keymap;
642 accmap = kbd->kb_accentmap;
643 fkeymap = kbd->kb_fkeytab;
644 fkeymap_size = kbd->kb_fkeytab_size;
648 if (!KBD_IS_PROBED(kbd)) {
649 kbd_init_struct(kbd, KEYBOARD_NAME, KB_OTHER, unit, flags, 0, 0);
650 bcopy(&key_map, keymap, sizeof(key_map));
651 bcopy(&accent_map, accmap, sizeof(accent_map));
652 bcopy(fkey_tab, fkeymap,
653 imin(fkeymap_size*sizeof(fkeymap[0]), sizeof(fkey_tab)));
654 kbd_set_maps(kbd, keymap, accmap, fkeymap, fkeymap_size);
655 kbd->kb_data = (void *)state;
657 KBD_FOUND_DEVICE(kbd);
661 vkbd_clear_state_locked(state);
662 state->ks_mode = K_XLATE;
663 /* FIXME: set the initial value for lock keys in ks_state */
666 if (!KBD_IS_INITIALIZED(kbd) && !(flags & KB_CONF_PROBE_ONLY)) {
667 kbd->kb_config = flags & ~KB_CONF_PROBE_ONLY;
669 vkbd_ioctl(kbd, KDSETLED, (caddr_t)&state->ks_state);
670 delay[0] = kbd->kb_delay1;
671 delay[1] = kbd->kb_delay2;
672 vkbd_ioctl(kbd, KDSETREPEAT, (caddr_t)delay);
676 if (!KBD_IS_CONFIGURED(kbd)) {
677 if (kbd_register(kbd) < 0) {
681 KBD_CONFIG_DONE(kbd);
690 free(keymap, M_VKBD);
692 free(accmap, M_VKBD);
694 free(fkeymap, M_VKBD);
697 *kbdp = NULL; /* insure ref doesn't leak to caller */
703 /* Finish using this keyboard */
705 vkbd_term(keyboard_t *kbd)
707 vkbd_state_t *state = (vkbd_state_t *) kbd->kb_data;
711 VKBD_LOCK_DESTROY(state);
712 bzero(state, sizeof(*state));
715 free(kbd->kb_keymap, M_VKBD);
716 free(kbd->kb_accentmap, M_VKBD);
717 free(kbd->kb_fkeytab, M_VKBD);
723 /* Keyboard interrupt routine */
725 vkbd_intr(keyboard_t *kbd, void *arg)
729 if (KBD_IS_ACTIVE(kbd) && KBD_IS_BUSY(kbd)) {
730 /* let the callback function to process the input */
731 (*kbd->kb_callback.kc_func)(kbd, KBDIO_KEYINPUT,
732 kbd->kb_callback.kc_arg);
734 /* read and discard the input; no one is waiting for input */
736 c = vkbd_read_char(kbd, FALSE);
737 } while (c != NOKEY);
743 /* Test the interface to the device */
745 vkbd_test_if(keyboard_t *kbd)
751 * Enable the access to the device; until this function is called,
752 * the client cannot read from the keyboard.
756 vkbd_enable(keyboard_t *kbd)
762 /* Disallow the access to the device */
764 vkbd_disable(keyboard_t *kbd)
770 /* Read one byte from the keyboard if it's allowed */
772 vkbd_read(keyboard_t *kbd, int wait)
774 vkbd_state_t *state = (vkbd_state_t *) kbd->kb_data;
778 c = vkbd_data_read(state, wait);
784 return (KBD_IS_ACTIVE(kbd)? c : -1);
787 /* Check if data is waiting */
789 vkbd_check(keyboard_t *kbd)
791 vkbd_state_t *state = NULL;
794 if (!KBD_IS_ACTIVE(kbd))
797 state = (vkbd_state_t *) kbd->kb_data;
800 ready = vkbd_data_ready(state);
806 /* Read char from the keyboard (stolen from atkbd.c) */
808 vkbd_read_char(keyboard_t *kbd, int wait)
810 vkbd_state_t *state = (vkbd_state_t *) kbd->kb_data;
812 int scancode, keycode;
818 /* do we have a composed char to return? */
819 if (!(state->ks_flags & COMPOSE) && (state->ks_composed_char > 0)) {
820 action = state->ks_composed_char;
821 state->ks_composed_char = 0;
822 if (action > UCHAR_MAX) {
831 /* see if there is something in the keyboard port */
832 scancode = vkbd_data_read(state, wait);
833 if (scancode == -1) {
837 /* XXX FIXME: check for -1 if wait == 1! */
841 /* return the byte as is for the K_RAW mode */
842 if (state->ks_mode == K_RAW) {
847 /* translate the scan code into a keycode */
848 keycode = scancode & 0x7F;
849 switch (state->ks_prefix) {
850 case 0x00: /* normal scancode */
852 case 0xB8: /* left alt (compose key) released */
853 if (state->ks_flags & COMPOSE) {
854 state->ks_flags &= ~COMPOSE;
855 if (state->ks_composed_char > UCHAR_MAX)
856 state->ks_composed_char = 0;
859 case 0x38: /* left alt (compose key) pressed */
860 if (!(state->ks_flags & COMPOSE)) {
861 state->ks_flags |= COMPOSE;
862 state->ks_composed_char = 0;
867 state->ks_prefix = scancode;
871 case 0xE0: /* 0xE0 prefix */
872 state->ks_prefix = 0;
874 case 0x1C: /* right enter key */
877 case 0x1D: /* right ctrl key */
880 case 0x35: /* keypad divide key */
883 case 0x37: /* print scrn key */
886 case 0x38: /* right alt key (alt gr) */
889 case 0x46: /* ctrl-pause/break on AT 101 (see below) */
892 case 0x47: /* grey home key */
895 case 0x48: /* grey up arrow key */
898 case 0x49: /* grey page up key */
901 case 0x4B: /* grey left arrow key */
904 case 0x4D: /* grey right arrow key */
907 case 0x4F: /* grey end key */
910 case 0x50: /* grey down arrow key */
913 case 0x51: /* grey page down key */
916 case 0x52: /* grey insert key */
919 case 0x53: /* grey delete key */
922 /* the following 3 are only used on the MS "Natural" keyboard */
923 case 0x5b: /* left Window key */
926 case 0x5c: /* right Window key */
929 case 0x5d: /* menu key */
932 case 0x5e: /* power key */
935 case 0x5f: /* sleep key */
938 case 0x63: /* wake key */
941 default: /* ignore everything else */
945 case 0xE1: /* 0xE1 prefix */
947 * The pause/break key on the 101 keyboard produces:
949 * Ctrl-pause/break produces:
950 * E0-46 E0-C6 (See above.)
952 state->ks_prefix = 0;
954 state->ks_prefix = 0x1D;
957 case 0x1D: /* pause / break */
958 state->ks_prefix = 0;
965 if (kbd->kb_type == KB_84) {
967 case 0x37: /* *(numpad)/print screen */
968 if (state->ks_flags & SHIFTS)
969 keycode = 0x5c; /* print screen */
971 case 0x45: /* num lock/pause */
972 if (state->ks_flags & CTLS)
973 keycode = 0x68; /* pause */
975 case 0x46: /* scroll lock/break */
976 if (state->ks_flags & CTLS)
977 keycode = 0x6c; /* break */
980 } else if (kbd->kb_type == KB_101) {
982 case 0x5c: /* print screen */
983 if (state->ks_flags & ALTS)
984 keycode = 0x54; /* sysrq */
986 case 0x68: /* pause/break */
987 if (state->ks_flags & CTLS)
988 keycode = 0x6c; /* break */
993 /* return the key code in the K_CODE mode */
994 if (state->ks_mode == K_CODE) {
996 return (keycode | (scancode & 0x80));
999 /* compose a character code */
1000 if (state->ks_flags & COMPOSE) {
1001 switch (keycode | (scancode & 0x80)) {
1002 /* key pressed, process it */
1003 case 0x47: case 0x48: case 0x49: /* keypad 7,8,9 */
1004 state->ks_composed_char *= 10;
1005 state->ks_composed_char += keycode - 0x40;
1006 if (state->ks_composed_char > UCHAR_MAX) {
1011 case 0x4B: case 0x4C: case 0x4D: /* keypad 4,5,6 */
1012 state->ks_composed_char *= 10;
1013 state->ks_composed_char += keycode - 0x47;
1014 if (state->ks_composed_char > UCHAR_MAX) {
1019 case 0x4F: case 0x50: case 0x51: /* keypad 1,2,3 */
1020 state->ks_composed_char *= 10;
1021 state->ks_composed_char += keycode - 0x4E;
1022 if (state->ks_composed_char > UCHAR_MAX) {
1027 case 0x52: /* keypad 0 */
1028 state->ks_composed_char *= 10;
1029 if (state->ks_composed_char > UCHAR_MAX) {
1035 /* key released, no interest here */
1036 case 0xC7: case 0xC8: case 0xC9: /* keypad 7,8,9 */
1037 case 0xCB: case 0xCC: case 0xCD: /* keypad 4,5,6 */
1038 case 0xCF: case 0xD0: case 0xD1: /* keypad 1,2,3 */
1039 case 0xD2: /* keypad 0 */
1042 case 0x38: /* left alt key */
1046 if (state->ks_composed_char > 0) {
1047 state->ks_flags &= ~COMPOSE;
1048 state->ks_composed_char = 0;
1056 /* keycode to key action */
1057 action = genkbd_keyaction(kbd, keycode, scancode & 0x80,
1058 &state->ks_state, &state->ks_accents);
1059 if (action == NOKEY)
1067 /* Check if char is waiting */
1069 vkbd_check_char(keyboard_t *kbd)
1071 vkbd_state_t *state = NULL;
1074 if (!KBD_IS_ACTIVE(kbd))
1077 state = (vkbd_state_t *) kbd->kb_data;
1080 if (!(state->ks_flags & COMPOSE) && (state->ks_composed_char > 0))
1083 ready = vkbd_data_ready(state);
1089 /* Some useful control functions (stolen from atkbd.c) */
1091 vkbd_ioctl(keyboard_t *kbd, u_long cmd, caddr_t arg)
1093 vkbd_state_t *state = (vkbd_state_t *) kbd->kb_data;
1095 #ifdef COMPAT_FREEBSD6
1102 case KDGKBMODE: /* get keyboard mode */
1103 *(int *)arg = state->ks_mode;
1106 #ifdef COMPAT_FREEBSD6
1108 ival = IOCPARM_IVAL(arg);
1109 arg = (caddr_t)&ival;
1112 case KDSKBMODE: /* set keyboard mode */
1113 switch (*(int *)arg) {
1115 if (state->ks_mode != K_XLATE) {
1116 /* make lock key state and LED state match */
1117 state->ks_state &= ~LOCK_MASK;
1118 state->ks_state |= KBD_LED_VAL(kbd);
1119 vkbd_status_changed(state);
1125 if (state->ks_mode != *(int *)arg) {
1126 vkbd_clear_state_locked(state);
1127 state->ks_mode = *(int *)arg;
1128 vkbd_status_changed(state);
1138 case KDGETLED: /* get keyboard LED */
1139 *(int *)arg = KBD_LED_VAL(kbd);
1142 #ifdef COMPAT_FREEBSD6
1144 ival = IOCPARM_IVAL(arg);
1145 arg = (caddr_t)&ival;
1148 case KDSETLED: /* set keyboard LED */
1149 /* NOTE: lock key state in ks_state won't be changed */
1150 if (*(int *)arg & ~LOCK_MASK) {
1156 /* replace CAPS LED with ALTGR LED for ALTGR keyboards */
1157 if (state->ks_mode == K_XLATE &&
1158 kbd->kb_keymap->n_keys > ALTGR_OFFSET) {
1165 KBD_LED_VAL(kbd) = *(int *)arg;
1166 vkbd_status_changed(state);
1169 case KDGKBSTATE: /* get lock key state */
1170 *(int *)arg = state->ks_state & LOCK_MASK;
1173 #ifdef COMPAT_FREEBSD6
1175 ival = IOCPARM_IVAL(arg);
1176 arg = (caddr_t)&ival;
1179 case KDSKBSTATE: /* set lock key state */
1180 if (*(int *)arg & ~LOCK_MASK) {
1184 state->ks_state &= ~LOCK_MASK;
1185 state->ks_state |= *(int *)arg;
1186 vkbd_status_changed(state);
1188 /* set LEDs and quit */
1189 return (vkbd_ioctl(kbd, KDSETLED, arg));
1191 case KDSETREPEAT: /* set keyboard repeat rate (new interface) */
1192 i = typematic(((int *)arg)[0], ((int *)arg)[1]);
1193 kbd->kb_delay1 = typematic_delay(i);
1194 kbd->kb_delay2 = typematic_rate(i);
1195 vkbd_status_changed(state);
1198 #ifdef COMPAT_FREEBSD6
1200 ival = IOCPARM_IVAL(arg);
1201 arg = (caddr_t)&ival;
1204 case KDSETRAD: /* set keyboard repeat rate (old interface) */
1205 kbd->kb_delay1 = typematic_delay(*(int *)arg);
1206 kbd->kb_delay2 = typematic_rate(*(int *)arg);
1207 vkbd_status_changed(state);
1210 case PIO_KEYMAP: /* set keyboard translation table */
1211 case PIO_KEYMAPENT: /* set keyboard translation table entry */
1212 case PIO_DEADKEYMAP: /* set accent key translation table */
1213 state->ks_accents = 0;
1218 return (genkbd_commonioctl(kbd, cmd, arg));
1226 /* Lock the access to the keyboard */
1228 vkbd_lock(keyboard_t *kbd, int lock)
1230 return (1); /* XXX */
1233 /* Clear the internal state of the keyboard */
1235 vkbd_clear_state_locked(vkbd_state_t *state)
1237 VKBD_LOCK_ASSERT(state, MA_OWNED);
1239 state->ks_flags &= ~COMPOSE;
1240 state->ks_polling = 0;
1241 state->ks_state &= LOCK_MASK; /* preserve locking key state */
1242 state->ks_accents = 0;
1243 state->ks_composed_char = 0;
1244 /* state->ks_prefix = 0; XXX */
1246 /* flush ks_inq and wakeup writers/poll()ers */
1247 state->ks_inq.head = state->ks_inq.tail = state->ks_inq.cc = 0;
1248 selwakeuppri(&state->ks_wsel, PZERO + 1);
1249 wakeup(&state->ks_inq);
1253 vkbd_clear_state(keyboard_t *kbd)
1255 vkbd_state_t *state = (vkbd_state_t *) kbd->kb_data;
1258 vkbd_clear_state_locked(state);
1262 /* Save the internal state */
1264 vkbd_get_state(keyboard_t *kbd, void *buf, size_t len)
1267 return (sizeof(vkbd_state_t));
1268 if (len < sizeof(vkbd_state_t))
1270 bcopy(kbd->kb_data, buf, sizeof(vkbd_state_t)); /* XXX locking? */
1274 /* Set the internal state */
1276 vkbd_set_state(keyboard_t *kbd, void *buf, size_t len)
1278 if (len < sizeof(vkbd_state_t))
1280 bcopy(buf, kbd->kb_data, sizeof(vkbd_state_t)); /* XXX locking? */
1286 vkbd_poll(keyboard_t *kbd, int on)
1288 vkbd_state_t *state = NULL;
1290 state = (vkbd_state_t *) kbd->kb_data;
1295 state->ks_polling ++;
1297 state->ks_polling --;
1308 static int delays[] = { 250, 500, 750, 1000 };
1309 static int rates[] = { 34, 38, 42, 46, 50, 55, 59, 63,
1310 68, 76, 84, 92, 100, 110, 118, 126,
1311 136, 152, 168, 184, 200, 220, 236, 252,
1312 272, 304, 336, 368, 400, 440, 472, 504 };
1315 typematic_delay(int i)
1317 return (delays[(i >> 5) & 3]);
1321 typematic_rate(int i)
1323 return (rates[i & 0x1f]);
1327 typematic(int delay, int rate)
1332 for (i = sizeof(delays)/sizeof(delays[0]) - 1; i > 0; i --) {
1333 if (delay >= delays[i])
1337 for (i = sizeof(rates)/sizeof(rates[0]) - 1; i > 0; i --) {
1338 if (rate >= rates[i])
1345 /*****************************************************************************
1346 *****************************************************************************
1348 *****************************************************************************
1349 *****************************************************************************/
1351 KEYBOARD_DRIVER(vkbd, vkbdsw, vkbd_configure);
1354 vkbd_modevent(module_t mod, int type, void *data)
1356 static eventhandler_tag tag;
1360 clone_setup(&vkbd_dev_clones);
1361 tag = EVENTHANDLER_REGISTER(dev_clone, vkbd_dev_clone, 0, 1000);
1363 clone_cleanup(&vkbd_dev_clones);
1366 kbd_add_driver(&vkbd_kbd_driver);
1370 kbd_delete_driver(&vkbd_kbd_driver);
1371 EVENTHANDLER_DEREGISTER(dev_clone, tag);
1372 clone_cleanup(&vkbd_dev_clones);
1376 return (EOPNOTSUPP);
1382 DEV_MODULE(vkbd, vkbd_modevent, NULL);