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,
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, unit2minor(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;
281 (*kbdsw[kbd->kb_index]->disable)(kbd);
282 #ifdef KBD_INSTALL_CDEV
284 #endif /* def KBD_INSTALL_CDEV */
285 (*kbdsw[kbd->kb_index]->term)(kbd);
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 :
441 (*kbdsw[kbd->kb_index]->ioctl)(kbd, cmd, data));
446 vkbd_dev_poll(struct cdev *dev, int events, struct thread *td)
448 vkbd_state_t *state = (vkbd_state_t *) dev->si_drv1;
449 vkbd_queue_t *q = NULL;
459 if (events & (POLLIN | POLLRDNORM)) {
460 if (state->ks_flags & STATUS)
461 revents |= events & (POLLIN | POLLRDNORM);
463 selrecord(td, &state->ks_rsel);
466 if (events & (POLLOUT | POLLWRNORM)) {
467 if (q->cc < sizeof(q->q)/sizeof(q->q[0]))
468 revents |= events & (POLLOUT | POLLWRNORM);
470 selrecord(td, &state->ks_wsel);
478 /* Interrupt handler */
480 vkbd_dev_intr(void *xkbd, int pending)
482 keyboard_t *kbd = (keyboard_t *) xkbd;
483 vkbd_state_t *state = (vkbd_state_t *) kbd->kb_data;
485 (*kbdsw[kbd->kb_index]->intr)(kbd, NULL);
489 state->ks_flags &= ~TASK;
490 wakeup(&state->ks_task);
495 /* Set status change flags */
497 vkbd_status_changed(vkbd_state_t *state)
499 VKBD_LOCK_ASSERT(state, MA_OWNED);
501 if (!(state->ks_flags & STATUS)) {
502 state->ks_flags |= STATUS;
503 selwakeuppri(&state->ks_rsel, PZERO + 1);
504 wakeup(&state->ks_flags);
508 /* Check if we have data in the input queue */
510 vkbd_data_ready(vkbd_state_t *state)
512 VKBD_LOCK_ASSERT(state, MA_OWNED);
514 return (state->ks_inq.cc > 0);
517 /* Read one code from the input queue */
519 vkbd_data_read(vkbd_state_t *state, int wait)
521 vkbd_queue_t *q = &state->ks_inq;
524 VKBD_LOCK_ASSERT(state, MA_OWNED);
529 /* get first code from the queue */
531 c = q->q[q->head ++];
532 if (q->head == sizeof(q->q)/sizeof(q->q[0]))
535 /* wakeup ks_inq writers/poll()ers */
536 selwakeuppri(&state->ks_wsel, PZERO + 1);
542 /****************************************************************************
543 ****************************************************************************
545 ****************************************************************************
546 ****************************************************************************/
548 static int vkbd_configure(int flags);
549 static kbd_probe_t vkbd_probe;
550 static kbd_init_t vkbd_init;
551 static kbd_term_t vkbd_term;
552 static kbd_intr_t vkbd_intr;
553 static kbd_test_if_t vkbd_test_if;
554 static kbd_enable_t vkbd_enable;
555 static kbd_disable_t vkbd_disable;
556 static kbd_read_t vkbd_read;
557 static kbd_check_t vkbd_check;
558 static kbd_read_char_t vkbd_read_char;
559 static kbd_check_char_t vkbd_check_char;
560 static kbd_ioctl_t vkbd_ioctl;
561 static kbd_lock_t vkbd_lock;
562 static void vkbd_clear_state_locked(vkbd_state_t *state);
563 static kbd_clear_state_t vkbd_clear_state;
564 static kbd_get_state_t vkbd_get_state;
565 static kbd_set_state_t vkbd_set_state;
566 static kbd_poll_mode_t vkbd_poll;
568 static keyboard_switch_t vkbdsw = {
573 .test_if = vkbd_test_if,
574 .enable = vkbd_enable,
575 .disable = vkbd_disable,
578 .read_char = vkbd_read_char,
579 .check_char = vkbd_check_char,
582 .clear_state = vkbd_clear_state,
583 .get_state = vkbd_get_state,
584 .set_state = vkbd_set_state,
585 .get_fkeystr = genkbd_get_fkeystr,
590 static int typematic(int delay, int rate);
591 static int typematic_delay(int delay);
592 static int typematic_rate(int rate);
594 /* Return the number of found keyboards */
596 vkbd_configure(int flags)
601 /* Detect a keyboard */
603 vkbd_probe(int unit, void *arg, int flags)
608 /* Reset and initialize the keyboard (stolen from atkbd.c) */
610 vkbd_init(int unit, keyboard_t **kbdp, void *arg, int flags)
612 keyboard_t *kbd = NULL;
613 vkbd_state_t *state = NULL;
614 keymap_t *keymap = NULL;
615 accentmap_t *accmap = NULL;
616 fkeytab_t *fkeymap = NULL;
617 int fkeymap_size, delay[2];
621 *kbdp = kbd = malloc(sizeof(*kbd), M_VKBD, M_NOWAIT | M_ZERO);
622 state = malloc(sizeof(*state), M_VKBD, M_NOWAIT | M_ZERO);
623 keymap = malloc(sizeof(key_map), M_VKBD, M_NOWAIT);
624 accmap = malloc(sizeof(accent_map), M_VKBD, M_NOWAIT);
625 fkeymap = malloc(sizeof(fkey_tab), M_VKBD, M_NOWAIT);
626 fkeymap_size = sizeof(fkey_tab)/sizeof(fkey_tab[0]);
628 if ((kbd == NULL) || (state == NULL) || (keymap == NULL) ||
629 (accmap == NULL) || (fkeymap == NULL)) {
634 VKBD_LOCK_INIT(state);
635 state->ks_inq.head = state->ks_inq.tail = state->ks_inq.cc = 0;
636 TASK_INIT(&state->ks_task, 0, vkbd_dev_intr, (void *) kbd);
637 } else if (KBD_IS_INITIALIZED(*kbdp) && KBD_IS_CONFIGURED(*kbdp)) {
641 state = (vkbd_state_t *) kbd->kb_data;
642 keymap = kbd->kb_keymap;
643 accmap = kbd->kb_accentmap;
644 fkeymap = kbd->kb_fkeytab;
645 fkeymap_size = kbd->kb_fkeytab_size;
649 if (!KBD_IS_PROBED(kbd)) {
650 kbd_init_struct(kbd, KEYBOARD_NAME, KB_OTHER, unit, flags, 0, 0);
651 bcopy(&key_map, keymap, sizeof(key_map));
652 bcopy(&accent_map, accmap, sizeof(accent_map));
653 bcopy(fkey_tab, fkeymap,
654 imin(fkeymap_size*sizeof(fkeymap[0]), sizeof(fkey_tab)));
655 kbd_set_maps(kbd, keymap, accmap, fkeymap, fkeymap_size);
656 kbd->kb_data = (void *)state;
658 KBD_FOUND_DEVICE(kbd);
662 vkbd_clear_state_locked(state);
663 state->ks_mode = K_XLATE;
664 /* FIXME: set the initial value for lock keys in ks_state */
667 if (!KBD_IS_INITIALIZED(kbd) && !(flags & KB_CONF_PROBE_ONLY)) {
668 kbd->kb_config = flags & ~KB_CONF_PROBE_ONLY;
670 vkbd_ioctl(kbd, KDSETLED, (caddr_t)&state->ks_state);
671 delay[0] = kbd->kb_delay1;
672 delay[1] = kbd->kb_delay2;
673 vkbd_ioctl(kbd, KDSETREPEAT, (caddr_t)delay);
677 if (!KBD_IS_CONFIGURED(kbd)) {
678 if (kbd_register(kbd) < 0) {
682 KBD_CONFIG_DONE(kbd);
691 free(keymap, M_VKBD);
693 free(accmap, M_VKBD);
695 free(fkeymap, M_VKBD);
698 *kbdp = NULL; /* insure ref doesn't leak to caller */
704 /* Finish using this keyboard */
706 vkbd_term(keyboard_t *kbd)
708 vkbd_state_t *state = (vkbd_state_t *) kbd->kb_data;
712 VKBD_LOCK_DESTROY(state);
713 bzero(state, sizeof(*state));
716 free(kbd->kb_keymap, M_VKBD);
717 free(kbd->kb_accentmap, M_VKBD);
718 free(kbd->kb_fkeytab, M_VKBD);
724 /* Keyboard interrupt routine */
726 vkbd_intr(keyboard_t *kbd, void *arg)
730 if (KBD_IS_ACTIVE(kbd) && KBD_IS_BUSY(kbd)) {
731 /* let the callback function to process the input */
732 (*kbd->kb_callback.kc_func)(kbd, KBDIO_KEYINPUT,
733 kbd->kb_callback.kc_arg);
735 /* read and discard the input; no one is waiting for input */
737 c = vkbd_read_char(kbd, FALSE);
738 } while (c != NOKEY);
744 /* Test the interface to the device */
746 vkbd_test_if(keyboard_t *kbd)
752 * Enable the access to the device; until this function is called,
753 * the client cannot read from the keyboard.
757 vkbd_enable(keyboard_t *kbd)
763 /* Disallow the access to the device */
765 vkbd_disable(keyboard_t *kbd)
771 /* Read one byte from the keyboard if it's allowed */
773 vkbd_read(keyboard_t *kbd, int wait)
775 vkbd_state_t *state = (vkbd_state_t *) kbd->kb_data;
779 c = vkbd_data_read(state, wait);
785 return (KBD_IS_ACTIVE(kbd)? c : -1);
788 /* Check if data is waiting */
790 vkbd_check(keyboard_t *kbd)
792 vkbd_state_t *state = NULL;
795 if (!KBD_IS_ACTIVE(kbd))
798 state = (vkbd_state_t *) kbd->kb_data;
801 ready = vkbd_data_ready(state);
807 /* Read char from the keyboard (stolen from atkbd.c) */
809 vkbd_read_char(keyboard_t *kbd, int wait)
811 vkbd_state_t *state = (vkbd_state_t *) kbd->kb_data;
813 int scancode, keycode;
819 /* do we have a composed char to return? */
820 if (!(state->ks_flags & COMPOSE) && (state->ks_composed_char > 0)) {
821 action = state->ks_composed_char;
822 state->ks_composed_char = 0;
823 if (action > UCHAR_MAX) {
832 /* see if there is something in the keyboard port */
833 scancode = vkbd_data_read(state, wait);
834 if (scancode == -1) {
838 /* XXX FIXME: check for -1 if wait == 1! */
842 /* return the byte as is for the K_RAW mode */
843 if (state->ks_mode == K_RAW) {
848 /* translate the scan code into a keycode */
849 keycode = scancode & 0x7F;
850 switch (state->ks_prefix) {
851 case 0x00: /* normal scancode */
853 case 0xB8: /* left alt (compose key) released */
854 if (state->ks_flags & COMPOSE) {
855 state->ks_flags &= ~COMPOSE;
856 if (state->ks_composed_char > UCHAR_MAX)
857 state->ks_composed_char = 0;
860 case 0x38: /* left alt (compose key) pressed */
861 if (!(state->ks_flags & COMPOSE)) {
862 state->ks_flags |= COMPOSE;
863 state->ks_composed_char = 0;
868 state->ks_prefix = scancode;
872 case 0xE0: /* 0xE0 prefix */
873 state->ks_prefix = 0;
875 case 0x1C: /* right enter key */
878 case 0x1D: /* right ctrl key */
881 case 0x35: /* keypad divide key */
884 case 0x37: /* print scrn key */
887 case 0x38: /* right alt key (alt gr) */
890 case 0x46: /* ctrl-pause/break on AT 101 (see below) */
893 case 0x47: /* grey home key */
896 case 0x48: /* grey up arrow key */
899 case 0x49: /* grey page up key */
902 case 0x4B: /* grey left arrow key */
905 case 0x4D: /* grey right arrow key */
908 case 0x4F: /* grey end key */
911 case 0x50: /* grey down arrow key */
914 case 0x51: /* grey page down key */
917 case 0x52: /* grey insert key */
920 case 0x53: /* grey delete key */
923 /* the following 3 are only used on the MS "Natural" keyboard */
924 case 0x5b: /* left Window key */
927 case 0x5c: /* right Window key */
930 case 0x5d: /* menu key */
933 case 0x5e: /* power key */
936 case 0x5f: /* sleep key */
939 case 0x63: /* wake key */
942 default: /* ignore everything else */
946 case 0xE1: /* 0xE1 prefix */
948 * The pause/break key on the 101 keyboard produces:
950 * Ctrl-pause/break produces:
951 * E0-46 E0-C6 (See above.)
953 state->ks_prefix = 0;
955 state->ks_prefix = 0x1D;
958 case 0x1D: /* pause / break */
959 state->ks_prefix = 0;
966 if (kbd->kb_type == KB_84) {
968 case 0x37: /* *(numpad)/print screen */
969 if (state->ks_flags & SHIFTS)
970 keycode = 0x5c; /* print screen */
972 case 0x45: /* num lock/pause */
973 if (state->ks_flags & CTLS)
974 keycode = 0x68; /* pause */
976 case 0x46: /* scroll lock/break */
977 if (state->ks_flags & CTLS)
978 keycode = 0x6c; /* break */
981 } else if (kbd->kb_type == KB_101) {
983 case 0x5c: /* print screen */
984 if (state->ks_flags & ALTS)
985 keycode = 0x54; /* sysrq */
987 case 0x68: /* pause/break */
988 if (state->ks_flags & CTLS)
989 keycode = 0x6c; /* break */
994 /* return the key code in the K_CODE mode */
995 if (state->ks_mode == K_CODE) {
997 return (keycode | (scancode & 0x80));
1000 /* compose a character code */
1001 if (state->ks_flags & COMPOSE) {
1002 switch (keycode | (scancode & 0x80)) {
1003 /* key pressed, process it */
1004 case 0x47: case 0x48: case 0x49: /* keypad 7,8,9 */
1005 state->ks_composed_char *= 10;
1006 state->ks_composed_char += keycode - 0x40;
1007 if (state->ks_composed_char > UCHAR_MAX) {
1012 case 0x4B: case 0x4C: case 0x4D: /* keypad 4,5,6 */
1013 state->ks_composed_char *= 10;
1014 state->ks_composed_char += keycode - 0x47;
1015 if (state->ks_composed_char > UCHAR_MAX) {
1020 case 0x4F: case 0x50: case 0x51: /* keypad 1,2,3 */
1021 state->ks_composed_char *= 10;
1022 state->ks_composed_char += keycode - 0x4E;
1023 if (state->ks_composed_char > UCHAR_MAX) {
1028 case 0x52: /* keypad 0 */
1029 state->ks_composed_char *= 10;
1030 if (state->ks_composed_char > UCHAR_MAX) {
1036 /* key released, no interest here */
1037 case 0xC7: case 0xC8: case 0xC9: /* keypad 7,8,9 */
1038 case 0xCB: case 0xCC: case 0xCD: /* keypad 4,5,6 */
1039 case 0xCF: case 0xD0: case 0xD1: /* keypad 1,2,3 */
1040 case 0xD2: /* keypad 0 */
1043 case 0x38: /* left alt key */
1047 if (state->ks_composed_char > 0) {
1048 state->ks_flags &= ~COMPOSE;
1049 state->ks_composed_char = 0;
1057 /* keycode to key action */
1058 action = genkbd_keyaction(kbd, keycode, scancode & 0x80,
1059 &state->ks_state, &state->ks_accents);
1060 if (action == NOKEY)
1068 /* Check if char is waiting */
1070 vkbd_check_char(keyboard_t *kbd)
1072 vkbd_state_t *state = NULL;
1075 if (!KBD_IS_ACTIVE(kbd))
1078 state = (vkbd_state_t *) kbd->kb_data;
1081 if (!(state->ks_flags & COMPOSE) && (state->ks_composed_char > 0))
1084 ready = vkbd_data_ready(state);
1090 /* Some useful control functions (stolen from atkbd.c) */
1092 vkbd_ioctl(keyboard_t *kbd, u_long cmd, caddr_t arg)
1094 vkbd_state_t *state = (vkbd_state_t *) kbd->kb_data;
1096 #ifdef COMPAT_FREEBSD6
1103 case KDGKBMODE: /* get keyboard mode */
1104 *(int *)arg = state->ks_mode;
1107 #ifdef COMPAT_FREEBSD6
1109 ival = IOCPARM_IVAL(arg);
1110 arg = (caddr_t)&ival;
1113 case KDSKBMODE: /* set keyboard mode */
1114 switch (*(int *)arg) {
1116 if (state->ks_mode != K_XLATE) {
1117 /* make lock key state and LED state match */
1118 state->ks_state &= ~LOCK_MASK;
1119 state->ks_state |= KBD_LED_VAL(kbd);
1120 vkbd_status_changed(state);
1126 if (state->ks_mode != *(int *)arg) {
1127 vkbd_clear_state_locked(state);
1128 state->ks_mode = *(int *)arg;
1129 vkbd_status_changed(state);
1139 case KDGETLED: /* get keyboard LED */
1140 *(int *)arg = KBD_LED_VAL(kbd);
1143 #ifdef COMPAT_FREEBSD6
1145 ival = IOCPARM_IVAL(arg);
1146 arg = (caddr_t)&ival;
1149 case KDSETLED: /* set keyboard LED */
1150 /* NOTE: lock key state in ks_state won't be changed */
1151 if (*(int *)arg & ~LOCK_MASK) {
1157 /* replace CAPS LED with ALTGR LED for ALTGR keyboards */
1158 if (state->ks_mode == K_XLATE &&
1159 kbd->kb_keymap->n_keys > ALTGR_OFFSET) {
1166 KBD_LED_VAL(kbd) = *(int *)arg;
1167 vkbd_status_changed(state);
1170 case KDGKBSTATE: /* get lock key state */
1171 *(int *)arg = state->ks_state & LOCK_MASK;
1174 #ifdef COMPAT_FREEBSD6
1176 ival = IOCPARM_IVAL(arg);
1177 arg = (caddr_t)&ival;
1180 case KDSKBSTATE: /* set lock key state */
1181 if (*(int *)arg & ~LOCK_MASK) {
1185 state->ks_state &= ~LOCK_MASK;
1186 state->ks_state |= *(int *)arg;
1187 vkbd_status_changed(state);
1189 /* set LEDs and quit */
1190 return (vkbd_ioctl(kbd, KDSETLED, arg));
1192 case KDSETREPEAT: /* set keyboard repeat rate (new interface) */
1193 i = typematic(((int *)arg)[0], ((int *)arg)[1]);
1194 kbd->kb_delay1 = typematic_delay(i);
1195 kbd->kb_delay2 = typematic_rate(i);
1196 vkbd_status_changed(state);
1199 #ifdef COMPAT_FREEBSD6
1201 ival = IOCPARM_IVAL(arg);
1202 arg = (caddr_t)&ival;
1205 case KDSETRAD: /* set keyboard repeat rate (old interface) */
1206 kbd->kb_delay1 = typematic_delay(*(int *)arg);
1207 kbd->kb_delay2 = typematic_rate(*(int *)arg);
1208 vkbd_status_changed(state);
1211 case PIO_KEYMAP: /* set keyboard translation table */
1212 case PIO_KEYMAPENT: /* set keyboard translation table entry */
1213 case PIO_DEADKEYMAP: /* set accent key translation table */
1214 state->ks_accents = 0;
1219 return (genkbd_commonioctl(kbd, cmd, arg));
1227 /* Lock the access to the keyboard */
1229 vkbd_lock(keyboard_t *kbd, int lock)
1231 return (1); /* XXX */
1234 /* Clear the internal state of the keyboard */
1236 vkbd_clear_state_locked(vkbd_state_t *state)
1238 VKBD_LOCK_ASSERT(state, MA_OWNED);
1240 state->ks_flags &= ~COMPOSE;
1241 state->ks_polling = 0;
1242 state->ks_state &= LOCK_MASK; /* preserve locking key state */
1243 state->ks_accents = 0;
1244 state->ks_composed_char = 0;
1245 /* state->ks_prefix = 0; XXX */
1247 /* flush ks_inq and wakeup writers/poll()ers */
1248 state->ks_inq.head = state->ks_inq.tail = state->ks_inq.cc = 0;
1249 selwakeuppri(&state->ks_wsel, PZERO + 1);
1250 wakeup(&state->ks_inq);
1254 vkbd_clear_state(keyboard_t *kbd)
1256 vkbd_state_t *state = (vkbd_state_t *) kbd->kb_data;
1259 vkbd_clear_state_locked(state);
1263 /* Save the internal state */
1265 vkbd_get_state(keyboard_t *kbd, void *buf, size_t len)
1268 return (sizeof(vkbd_state_t));
1269 if (len < sizeof(vkbd_state_t))
1271 bcopy(kbd->kb_data, buf, sizeof(vkbd_state_t)); /* XXX locking? */
1275 /* Set the internal state */
1277 vkbd_set_state(keyboard_t *kbd, void *buf, size_t len)
1279 if (len < sizeof(vkbd_state_t))
1281 bcopy(buf, kbd->kb_data, sizeof(vkbd_state_t)); /* XXX locking? */
1287 vkbd_poll(keyboard_t *kbd, int on)
1289 vkbd_state_t *state = NULL;
1291 state = (vkbd_state_t *) kbd->kb_data;
1296 state->ks_polling ++;
1298 state->ks_polling --;
1309 static int delays[] = { 250, 500, 750, 1000 };
1310 static int rates[] = { 34, 38, 42, 46, 50, 55, 59, 63,
1311 68, 76, 84, 92, 100, 110, 118, 126,
1312 136, 152, 168, 184, 200, 220, 236, 252,
1313 272, 304, 336, 368, 400, 440, 472, 504 };
1316 typematic_delay(int i)
1318 return (delays[(i >> 5) & 3]);
1322 typematic_rate(int i)
1324 return (rates[i & 0x1f]);
1328 typematic(int delay, int rate)
1333 for (i = sizeof(delays)/sizeof(delays[0]) - 1; i > 0; i --) {
1334 if (delay >= delays[i])
1338 for (i = sizeof(rates)/sizeof(rates[0]) - 1; i > 0; i --) {
1339 if (rate >= rates[i])
1346 /*****************************************************************************
1347 *****************************************************************************
1349 *****************************************************************************
1350 *****************************************************************************/
1352 KEYBOARD_DRIVER(vkbd, vkbdsw, vkbd_configure);
1355 vkbd_modevent(module_t mod, int type, void *data)
1357 static eventhandler_tag tag;
1361 clone_setup(&vkbd_dev_clones);
1362 tag = EVENTHANDLER_REGISTER(dev_clone, vkbd_dev_clone, 0, 1000);
1364 clone_cleanup(&vkbd_dev_clones);
1367 kbd_add_driver(&vkbd_kbd_driver);
1371 kbd_delete_driver(&vkbd_kbd_driver);
1372 EVENTHANDLER_DEREGISTER(dev_clone, tag);
1373 clone_cleanup(&vkbd_dev_clones);
1377 return (EOPNOTSUPP);
1383 DEV_MODULE(vkbd, vkbd_modevent, NULL);