2 * Copyright (c) 2012 Oleksandr Tymoshenko <gonzo@freebsd.org>
5 * Based on dev/usb/input/ukbd.c
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.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 #include <sys/cdefs.h>
30 __FBSDID("$FreeBSD$");
32 #include <sys/param.h>
33 #include <sys/systm.h>
35 #include <sys/kernel.h>
36 #include <sys/module.h>
37 #include <sys/malloc.h>
40 #include <sys/sched.h>
43 #include <machine/bus.h>
44 #include <machine/cpu.h>
45 #include <machine/intr.h>
47 #include <dev/ofw/openfirm.h>
48 #include <dev/ofw/ofw_bus.h>
49 #include <dev/ofw/ofw_bus_subr.h>
51 #include <sys/ioccom.h>
52 #include <sys/filio.h>
56 #include <dev/kbd/kbdreg.h>
58 #include <machine/bus.h>
60 #include <dev/kbd/kbdtables.h>
62 #define KMI_LOCK() mtx_lock(&Giant)
63 #define KMI_UNLOCK() mtx_unlock(&Giant)
67 * Assert that the lock is held in all contexts
68 * where the code can be executed.
70 #define KMI_LOCK_ASSERT() mtx_assert(&Giant, MA_OWNED)
72 * Assert that the lock is held in the contexts
73 * where it really has to be so.
75 #define KMI_CTX_LOCK_ASSERT() \
77 if (!kdb_active && panicstr == NULL) \
78 mtx_assert(&Giant, MA_OWNED); \
81 #define KMI_LOCK_ASSERT() (void)0
82 #define KMI_CTX_LOCK_ASSERT() (void)0
86 #define KMICR_TYPE_NONPS2 (1 << 5)
87 #define KMICR_RXINTREN (1 << 4)
88 #define KMICR_TXINTREN (1 << 3)
89 #define KMICR_EN (1 << 2)
90 #define KMICR_FKMID (1 << 1)
91 #define KMICR_FKMIC (1 << 0)
93 #define KMISTAT_TXEMPTY (1 << 6)
94 #define KMISTAT_TXBUSY (1 << 5)
95 #define KMISTAT_RXFULL (1 << 4)
96 #define KMISTAT_RXBUSY (1 << 3)
97 #define KMISTAT_RXPARITY (1 << 2)
98 #define KMISTAT_KMIC (1 << 1)
99 #define KMISTAT_KMID (1 << 0)
101 #define KMICLKDIV 0x0C
103 #define KMIIR_TXINTR (1 << 1)
104 #define KMIIR_RXINTR (1 << 0)
106 #define KMI_DRIVER_NAME "kmi"
107 #define KMI_NFKEY (sizeof(fkey_tab)/sizeof(fkey_tab[0])) /* units */
109 #define SET_SCANCODE_SET 0xf0
115 accentmap_t sc_accmap;
116 fkeytab_t sc_fkeymap[KMI_NFKEY];
118 struct resource* sc_mem_res;
119 struct resource* sc_irq_res;
122 int sc_mode; /* input mode (K_XLATE,K_RAW,K_CODE) */
123 int sc_state; /* shift/lock key state */
124 int sc_accents; /* accent key index (> 0) */
125 uint32_t sc_flags; /* flags */
126 #define KMI_FLAG_COMPOSE 0x00000001
127 #define KMI_FLAG_POLLING 0x00000002
129 struct thread *sc_poll_thread;
132 /* Read/Write macros for Timer used as timecounter */
133 #define pl050_kmi_read_4(sc, reg) \
134 bus_read_4((sc)->sc_mem_res, (reg))
136 #define pl050_kmi_write_4(sc, reg, val) \
137 bus_write_4((sc)->sc_mem_res, (reg), (val))
140 static void kmi_set_leds(struct kmi_softc *, uint8_t);
141 static int kmi_set_typematic(keyboard_t *, int);
142 static uint32_t kmi_read_char(keyboard_t *, int);
143 static void kmi_clear_state(keyboard_t *);
144 static int kmi_ioctl(keyboard_t *, u_long, caddr_t);
145 static int kmi_enable(keyboard_t *);
146 static int kmi_disable(keyboard_t *);
148 static int kmi_attached = 0;
150 /* early keyboard probe, not supported */
152 kmi_configure(int flags)
157 /* detect a keyboard, not used */
159 kmi_probe(int unit, void *arg, int flags)
164 /* reset and initialize the device, not used */
166 kmi_init(int unit, keyboard_t **kbdp, void *arg, int flags)
171 /* test the interface to the device, not used */
173 kmi_test_if(keyboard_t *kbd)
178 /* finish using this keyboard, not used */
180 kmi_term(keyboard_t *kbd)
185 /* keyboard interrupt routine, not used */
187 kmi_intr(keyboard_t *kbd, void *arg)
193 /* lock the access to the keyboard, not used */
195 kmi_lock(keyboard_t *kbd, int lock)
201 * Enable the access to the device; until this function is called,
202 * the client cannot read from the keyboard.
205 kmi_enable(keyboard_t *kbd)
215 /* disallow the access to the device */
217 kmi_disable(keyboard_t *kbd)
227 /* check if data is waiting */
229 kmi_check(keyboard_t *kbd)
231 struct kmi_softc *sc = kbd->kb_data;
234 KMI_CTX_LOCK_ASSERT();
236 if (!KBD_IS_ACTIVE(kbd))
239 reg = pl050_kmi_read_4(sc, KMIIR);
240 return (reg & KMIIR_RXINTR);
243 /* check if char is waiting */
245 kmi_check_char_locked(keyboard_t *kbd)
247 KMI_CTX_LOCK_ASSERT();
249 if (!KBD_IS_ACTIVE(kbd))
252 return (kmi_check(kbd));
256 kmi_check_char(keyboard_t *kbd)
261 result = kmi_check_char_locked(kbd);
267 /* read one byte from the keyboard if it's allowed */
268 /* Currently unused. */
270 kmi_read(keyboard_t *kbd, int wait)
272 KMI_CTX_LOCK_ASSERT();
274 if (!KBD_IS_ACTIVE(kbd))
278 printf("Implement ME: %s\n", __func__);
282 /* read char from the keyboard */
284 kmi_read_char_locked(keyboard_t *kbd, int wait)
286 struct kmi_softc *sc = kbd->kb_data;
289 KMI_CTX_LOCK_ASSERT();
291 if (!KBD_IS_ACTIVE(kbd))
294 reg = pl050_kmi_read_4(sc, KMIIR);
295 if (reg & KMIIR_RXINTR) {
296 data = pl050_kmi_read_4(sc, KMIDATA);
304 /* Currently wait is always false. */
306 kmi_read_char(keyboard_t *kbd, int wait)
311 keycode = kmi_read_char_locked(kbd, wait);
317 /* some useful control functions */
319 kmi_ioctl_locked(keyboard_t *kbd, u_long cmd, caddr_t arg)
321 struct kmi_softc *sc = kbd->kb_data;
323 #if defined(COMPAT_FREEBSD6) || defined(COMPAT_FREEBSD5) || \
324 defined(COMPAT_FREEBSD4) || defined(COMPAT_43)
332 case KDGKBMODE: /* get keyboard mode */
333 *(int *)arg = sc->sc_mode;
335 #if defined(COMPAT_FREEBSD6) || defined(COMPAT_FREEBSD5) || \
336 defined(COMPAT_FREEBSD4) || defined(COMPAT_43)
338 ival = IOCPARM_IVAL(arg);
339 arg = (caddr_t)&ival;
342 case KDSKBMODE: /* set keyboard mode */
343 switch (*(int *)arg) {
345 if (sc->sc_mode != K_XLATE) {
346 /* make lock key state and LED state match */
347 sc->sc_state &= ~LOCK_MASK;
348 sc->sc_state |= KBD_LED_VAL(kbd);
353 if (sc->sc_mode != *(int *)arg) {
354 if ((sc->sc_flags & KMI_FLAG_POLLING) == 0)
355 kmi_clear_state(kbd);
356 sc->sc_mode = *(int *)arg;
364 case KDGETLED: /* get keyboard LED */
365 *(int *)arg = KBD_LED_VAL(kbd);
367 #if defined(COMPAT_FREEBSD6) || defined(COMPAT_FREEBSD5) || \
368 defined(COMPAT_FREEBSD4) || defined(COMPAT_43)
370 ival = IOCPARM_IVAL(arg);
371 arg = (caddr_t)&ival;
374 case KDSETLED: /* set keyboard LED */
375 /* NOTE: lock key state in "sc_state" won't be changed */
376 if (*(int *)arg & ~LOCK_MASK)
381 /* replace CAPS LED with ALTGR LED for ALTGR keyboards */
382 if (sc->sc_mode == K_XLATE &&
383 kbd->kb_keymap->n_keys > ALTGR_OFFSET) {
389 if (KBD_HAS_DEVICE(kbd))
392 KBD_LED_VAL(kbd) = *(int *)arg;
394 case KDGKBSTATE: /* get lock key state */
395 *(int *)arg = sc->sc_state & LOCK_MASK;
397 #if defined(COMPAT_FREEBSD6) || defined(COMPAT_FREEBSD5) || \
398 defined(COMPAT_FREEBSD4) || defined(COMPAT_43)
400 ival = IOCPARM_IVAL(arg);
401 arg = (caddr_t)&ival;
404 case KDSKBSTATE: /* set lock key state */
405 if (*(int *)arg & ~LOCK_MASK) {
408 sc->sc_state &= ~LOCK_MASK;
409 sc->sc_state |= *(int *)arg;
411 /* set LEDs and quit */
412 return (kmi_ioctl(kbd, KDSETLED, arg));
414 case KDSETREPEAT: /* set keyboard repeat rate (new
416 if (!KBD_HAS_DEVICE(kbd)) {
419 if (((int *)arg)[1] < 0) {
422 if (((int *)arg)[0] < 0) {
425 if (((int *)arg)[0] < 200) /* fastest possible value */
426 kbd->kb_delay1 = 200;
428 kbd->kb_delay1 = ((int *)arg)[0];
429 kbd->kb_delay2 = ((int *)arg)[1];
432 #if defined(COMPAT_FREEBSD6) || defined(COMPAT_FREEBSD5) || \
433 defined(COMPAT_FREEBSD4) || defined(COMPAT_43)
435 ival = IOCPARM_IVAL(arg);
436 arg = (caddr_t)&ival;
439 case KDSETRAD: /* set keyboard repeat rate (old
441 return (kmi_set_typematic(kbd, *(int *)arg));
443 case PIO_KEYMAP: /* set keyboard translation table */
444 case OPIO_KEYMAP: /* set keyboard translation table
446 case PIO_KEYMAPENT: /* set keyboard translation table
448 case PIO_DEADKEYMAP: /* set accent key translation table */
452 return (genkbd_commonioctl(kbd, cmd, arg));
459 kmi_ioctl(keyboard_t *kbd, u_long cmd, caddr_t arg)
464 * XXX KDGKBSTATE, KDSKBSTATE and KDSETLED can be called from any
465 * context where printf(9) can be called, which among other things
466 * includes interrupt filters and threads with any kinds of locks
467 * already held. For this reason it would be dangerous to acquire
468 * the Giant here unconditionally. On the other hand we have to
469 * have it to handle the ioctl.
470 * So we make our best effort to auto-detect whether we can grab
471 * the Giant or not. Blame syscons(4) for this.
477 if (!mtx_owned(&Giant) && !SCHEDULER_STOPPED())
478 return (EDEADLK); /* best I could come up with */
482 result = kmi_ioctl_locked(kbd, cmd, arg);
488 /* clear the internal state of the keyboard */
490 kmi_clear_state(keyboard_t *kbd)
492 struct kmi_softc *sc = kbd->kb_data;
494 KMI_CTX_LOCK_ASSERT();
496 sc->sc_flags &= ~(KMI_FLAG_COMPOSE | KMI_FLAG_POLLING);
497 sc->sc_state &= LOCK_MASK; /* preserve locking key state */
501 /* save the internal state, not used */
503 kmi_get_state(keyboard_t *kbd, void *buf, size_t len)
505 return (len == 0) ? 1 : -1;
508 /* set the internal state, not used */
510 kmi_set_state(keyboard_t *kbd, void *buf, size_t len)
516 kmi_poll(keyboard_t *kbd, int on)
518 struct kmi_softc *sc = kbd->kb_data;
522 sc->sc_flags |= KMI_FLAG_POLLING;
523 sc->sc_poll_thread = curthread;
525 sc->sc_flags &= ~KMI_FLAG_POLLING;
532 /* local functions */
535 kmi_set_leds(struct kmi_softc *sc, uint8_t leds)
540 /* start transfer, if not already started */
541 printf("Implement me: %s\n", __func__);
545 kmi_set_typematic(keyboard_t *kbd, int code)
547 static const int delays[] = {250, 500, 750, 1000};
548 static const int rates[] = {34, 38, 42, 46, 50, 55, 59, 63,
549 68, 76, 84, 92, 100, 110, 118, 126,
550 136, 152, 168, 184, 200, 220, 236, 252,
551 272, 304, 336, 368, 400, 440, 472, 504};
556 kbd->kb_delay1 = delays[(code >> 5) & 3];
557 kbd->kb_delay2 = rates[code & 0x1f];
561 static keyboard_switch_t kmisw = {
566 .test_if = &kmi_test_if,
567 .enable = &kmi_enable,
568 .disable = &kmi_disable,
571 .read_char = &kmi_read_char,
572 .check_char = &kmi_check_char,
575 .clear_state = &kmi_clear_state,
576 .get_state = &kmi_get_state,
577 .set_state = &kmi_set_state,
578 .get_fkeystr = &genkbd_get_fkeystr,
580 .diag = &genkbd_diag,
583 KEYBOARD_DRIVER(kmi, kmisw, kmi_configure);
586 pl050_kmi_intr(void *arg)
588 struct kmi_softc *sc = arg;
591 KMI_CTX_LOCK_ASSERT();
593 if ((sc->sc_flags & KMI_FLAG_POLLING) != 0)
596 if (KBD_IS_ACTIVE(&sc->sc_kbd) &&
597 KBD_IS_BUSY(&sc->sc_kbd)) {
598 /* let the callback function process the input */
599 (sc->sc_kbd.kb_callback.kc_func) (&sc->sc_kbd, KBDIO_KEYINPUT,
600 sc->sc_kbd.kb_callback.kc_arg);
602 /* read and discard the input, no one is waiting for it */
604 c = kmi_read_char_locked(&sc->sc_kbd, 0);
605 } while (c != NOKEY);
611 pl050_kmi_probe(device_t dev)
614 if (!ofw_bus_status_okay(dev))
618 * PL050 is plain PS2 port that pushes bytes to/from computer
619 * VersatilePB has two such ports and QEMU simulates keyboard
620 * connected to port #0 and mouse connected to port #1. This
621 * information can't be obtained from device tree so we just
622 * hardcode this knowledge here. We attach keyboard driver to
623 * port #0 and ignore port #1
628 if (ofw_bus_is_compatible(dev, "arm,pl050")) {
629 device_set_desc(dev, "PL050 Keyboard/Mouse Interface");
630 return (BUS_PROBE_DEFAULT);
637 pl050_kmi_attach(device_t dev)
639 struct kmi_softc *sc = device_get_softc(dev);
649 sc->sc_mem_res = bus_alloc_resource_any(dev, SYS_RES_MEMORY, &rid, RF_ACTIVE);
650 if (sc->sc_mem_res == NULL) {
651 device_printf(dev, "could not allocate memory resource\n");
655 /* Request the IRQ resources */
656 sc->sc_irq_res = bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid, RF_ACTIVE);
657 if (sc->sc_irq_res == NULL) {
658 device_printf(dev, "Error: could not allocate irq resources\n");
662 /* Setup and enable the timer */
663 if (bus_setup_intr(dev, sc->sc_irq_res, INTR_TYPE_CLK,
664 NULL, pl050_kmi_intr, sc,
665 &sc->sc_intr_hl) != 0) {
666 bus_release_resource(dev, SYS_RES_IRQ, rid,
668 device_printf(dev, "Unable to setup the clock irq handler.\n");
672 /* TODO: clock & divisor */
674 pl050_kmi_write_4(sc, KMICR, KMICR_EN);
676 pl050_kmi_write_4(sc, KMIDATA, SET_SCANCODE_SET);
678 ack = pl050_kmi_read_4(sc, KMIDATA);
679 /* Set Scan Code set 1 (XT) */
680 pl050_kmi_write_4(sc, KMIDATA, 1);
682 ack = pl050_kmi_read_4(sc, KMIDATA);
684 pl050_kmi_write_4(sc, KMICR, KMICR_EN | KMICR_RXINTREN);
686 kbd_init_struct(kbd, KMI_DRIVER_NAME, KB_OTHER,
687 device_get_unit(dev), 0, 0, 0);
688 kbd->kb_data = (void *)sc;
690 sc->sc_keymap = key_map;
691 sc->sc_accmap = accent_map;
692 for (i = 0; i < KMI_NFKEY; i++) {
693 sc->sc_fkeymap[i] = fkey_tab[i];
696 kbd_set_maps(kbd, &sc->sc_keymap, &sc->sc_accmap,
697 sc->sc_fkeymap, KMI_NFKEY);
699 KBD_FOUND_DEVICE(kbd);
700 kmi_clear_state(kbd);
705 if (kbd_register(kbd) < 0) {
708 KBD_CONFIG_DONE(kbd);
710 #ifdef KBD_INSTALL_CDEV
711 if (kbd_attach(kbd)) {
717 genkbd_diag(kbd, bootverbose);
727 static device_method_t pl050_kmi_methods[] = {
728 DEVMETHOD(device_probe, pl050_kmi_probe),
729 DEVMETHOD(device_attach, pl050_kmi_attach),
733 static driver_t pl050_kmi_driver = {
736 sizeof(struct kmi_softc),
739 static devclass_t pl050_kmi_devclass;
741 DRIVER_MODULE(pl050_kmi, simplebus, pl050_kmi_driver, pl050_kmi_devclass, 0, 0);