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/frame.h>
46 #include <machine/intr.h>
48 #include <dev/fdt/fdt_common.h>
49 #include <dev/ofw/openfirm.h>
50 #include <dev/ofw/ofw_bus.h>
51 #include <dev/ofw/ofw_bus_subr.h>
53 #include <sys/ioccom.h>
54 #include <sys/filio.h>
58 #include <dev/kbd/kbdreg.h>
60 #include <machine/bus.h>
61 #include <machine/fdt.h>
63 #include <dev/kbd/kbdtables.h>
65 #define KMI_LOCK() mtx_lock(&Giant)
66 #define KMI_UNLOCK() mtx_unlock(&Giant)
70 * Assert that the lock is held in all contexts
71 * where the code can be executed.
73 #define KMI_LOCK_ASSERT() mtx_assert(&Giant, MA_OWNED)
75 * Assert that the lock is held in the contexts
76 * where it really has to be so.
78 #define KMI_CTX_LOCK_ASSERT() \
80 if (!kdb_active && panicstr == NULL) \
81 mtx_assert(&Giant, MA_OWNED); \
84 #define KMI_LOCK_ASSERT() (void)0
85 #define KMI_CTX_LOCK_ASSERT() (void)0
89 #define KMICR_TYPE_NONPS2 (1 << 5)
90 #define KMICR_RXINTREN (1 << 4)
91 #define KMICR_TXINTREN (1 << 3)
92 #define KMICR_EN (1 << 2)
93 #define KMICR_FKMID (1 << 1)
94 #define KMICR_FKMIC (1 << 0)
96 #define KMISTAT_TXEMPTY (1 << 6)
97 #define KMISTAT_TXBUSY (1 << 5)
98 #define KMISTAT_RXFULL (1 << 4)
99 #define KMISTAT_RXBUSY (1 << 3)
100 #define KMISTAT_RXPARITY (1 << 2)
101 #define KMISTAT_KMIC (1 << 1)
102 #define KMISTAT_KMID (1 << 0)
104 #define KMICLKDIV 0x0C
106 #define KMIIR_TXINTR (1 << 1)
107 #define KMIIR_RXINTR (1 << 0)
109 #define KMI_DRIVER_NAME "kmi"
110 #define KMI_NFKEY (sizeof(fkey_tab)/sizeof(fkey_tab[0])) /* units */
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 /* early keyboard probe, not supported */
150 kmi_configure(int flags)
155 /* detect a keyboard, not used */
157 kmi_probe(int unit, void *arg, int flags)
162 /* reset and initialize the device, not used */
164 kmi_init(int unit, keyboard_t **kbdp, void *arg, int flags)
169 /* test the interface to the device, not used */
171 kmi_test_if(keyboard_t *kbd)
176 /* finish using this keyboard, not used */
178 kmi_term(keyboard_t *kbd)
183 /* keyboard interrupt routine, not used */
185 kmi_intr(keyboard_t *kbd, void *arg)
191 /* lock the access to the keyboard, not used */
193 kmi_lock(keyboard_t *kbd, int lock)
199 * Enable the access to the device; until this function is called,
200 * the client cannot read from the keyboard.
203 kmi_enable(keyboard_t *kbd)
213 /* disallow the access to the device */
215 kmi_disable(keyboard_t *kbd)
225 /* check if data is waiting */
227 kmi_check(keyboard_t *kbd)
229 struct kmi_softc *sc = kbd->kb_data;
232 KMI_CTX_LOCK_ASSERT();
234 if (!KBD_IS_ACTIVE(kbd))
237 reg = pl050_kmi_read_4(sc, KMIIR);
238 return (reg & KMIIR_RXINTR);
241 /* check if char is waiting */
243 kmi_check_char_locked(keyboard_t *kbd)
245 KMI_CTX_LOCK_ASSERT();
247 if (!KBD_IS_ACTIVE(kbd))
250 return (kmi_check(kbd));
254 kmi_check_char(keyboard_t *kbd)
259 result = kmi_check_char_locked(kbd);
265 /* read one byte from the keyboard if it's allowed */
266 /* Currently unused. */
268 kmi_read(keyboard_t *kbd, int wait)
270 KMI_CTX_LOCK_ASSERT();
272 if (!KBD_IS_ACTIVE(kbd))
276 printf("Implement ME: %s\n", __func__);
280 /* read char from the keyboard */
282 kmi_read_char_locked(keyboard_t *kbd, int wait)
284 struct kmi_softc *sc = kbd->kb_data;
287 KMI_CTX_LOCK_ASSERT();
289 if (!KBD_IS_ACTIVE(kbd))
292 reg = pl050_kmi_read_4(sc, KMIIR);
293 if (reg & KMIIR_RXINTR) {
294 data = pl050_kmi_read_4(sc, KMIDATA);
302 /* Currently wait is always false. */
304 kmi_read_char(keyboard_t *kbd, int wait)
309 keycode = kmi_read_char_locked(kbd, wait);
315 /* some useful control functions */
317 kmi_ioctl_locked(keyboard_t *kbd, u_long cmd, caddr_t arg)
319 struct kmi_softc *sc = kbd->kb_data;
321 #if defined(COMPAT_FREEBSD6) || defined(COMPAT_FREEBSD5) || \
322 defined(COMPAT_FREEBSD4) || defined(COMPAT_43)
330 case KDGKBMODE: /* get keyboard mode */
331 *(int *)arg = sc->sc_mode;
333 #if defined(COMPAT_FREEBSD6) || defined(COMPAT_FREEBSD5) || \
334 defined(COMPAT_FREEBSD4) || defined(COMPAT_43)
336 ival = IOCPARM_IVAL(arg);
337 arg = (caddr_t)&ival;
340 case KDSKBMODE: /* set keyboard mode */
341 switch (*(int *)arg) {
343 if (sc->sc_mode != K_XLATE) {
344 /* make lock key state and LED state match */
345 sc->sc_state &= ~LOCK_MASK;
346 sc->sc_state |= KBD_LED_VAL(kbd);
351 if (sc->sc_mode != *(int *)arg) {
352 if ((sc->sc_flags & KMI_FLAG_POLLING) == 0)
353 kmi_clear_state(kbd);
354 sc->sc_mode = *(int *)arg;
362 case KDGETLED: /* get keyboard LED */
363 *(int *)arg = KBD_LED_VAL(kbd);
365 #if defined(COMPAT_FREEBSD6) || defined(COMPAT_FREEBSD5) || \
366 defined(COMPAT_FREEBSD4) || defined(COMPAT_43)
368 ival = IOCPARM_IVAL(arg);
369 arg = (caddr_t)&ival;
372 case KDSETLED: /* set keyboard LED */
373 /* NOTE: lock key state in "sc_state" won't be changed */
374 if (*(int *)arg & ~LOCK_MASK)
379 /* replace CAPS LED with ALTGR LED for ALTGR keyboards */
380 if (sc->sc_mode == K_XLATE &&
381 kbd->kb_keymap->n_keys > ALTGR_OFFSET) {
387 if (KBD_HAS_DEVICE(kbd))
390 KBD_LED_VAL(kbd) = *(int *)arg;
392 case KDGKBSTATE: /* get lock key state */
393 *(int *)arg = sc->sc_state & LOCK_MASK;
395 #if defined(COMPAT_FREEBSD6) || defined(COMPAT_FREEBSD5) || \
396 defined(COMPAT_FREEBSD4) || defined(COMPAT_43)
398 ival = IOCPARM_IVAL(arg);
399 arg = (caddr_t)&ival;
402 case KDSKBSTATE: /* set lock key state */
403 if (*(int *)arg & ~LOCK_MASK) {
406 sc->sc_state &= ~LOCK_MASK;
407 sc->sc_state |= *(int *)arg;
409 /* set LEDs and quit */
410 return (kmi_ioctl(kbd, KDSETLED, arg));
412 case KDSETREPEAT: /* set keyboard repeat rate (new
414 if (!KBD_HAS_DEVICE(kbd)) {
417 if (((int *)arg)[1] < 0) {
420 if (((int *)arg)[0] < 0) {
423 if (((int *)arg)[0] < 200) /* fastest possible value */
424 kbd->kb_delay1 = 200;
426 kbd->kb_delay1 = ((int *)arg)[0];
427 kbd->kb_delay2 = ((int *)arg)[1];
430 #if defined(COMPAT_FREEBSD6) || defined(COMPAT_FREEBSD5) || \
431 defined(COMPAT_FREEBSD4) || defined(COMPAT_43)
433 ival = IOCPARM_IVAL(arg);
434 arg = (caddr_t)&ival;
437 case KDSETRAD: /* set keyboard repeat rate (old
439 return (kmi_set_typematic(kbd, *(int *)arg));
441 case PIO_KEYMAP: /* set keyboard translation table */
442 case OPIO_KEYMAP: /* set keyboard translation table
444 case PIO_KEYMAPENT: /* set keyboard translation table
446 case PIO_DEADKEYMAP: /* set accent key translation table */
450 return (genkbd_commonioctl(kbd, cmd, arg));
457 kmi_ioctl(keyboard_t *kbd, u_long cmd, caddr_t arg)
462 * XXX KDGKBSTATE, KDSKBSTATE and KDSETLED can be called from any
463 * context where printf(9) can be called, which among other things
464 * includes interrupt filters and threads with any kinds of locks
465 * already held. For this reason it would be dangerous to acquire
466 * the Giant here unconditionally. On the other hand we have to
467 * have it to handle the ioctl.
468 * So we make our best effort to auto-detect whether we can grab
469 * the Giant or not. Blame syscons(4) for this.
475 if (!mtx_owned(&Giant) && !SCHEDULER_STOPPED())
476 return (EDEADLK); /* best I could come up with */
480 result = kmi_ioctl_locked(kbd, cmd, arg);
487 /* clear the internal state of the keyboard */
489 kmi_clear_state(keyboard_t *kbd)
491 struct kmi_softc *sc = kbd->kb_data;
493 KMI_CTX_LOCK_ASSERT();
495 sc->sc_flags &= ~(KMI_FLAG_COMPOSE | KMI_FLAG_POLLING);
496 sc->sc_state &= LOCK_MASK; /* preserve locking key state */
500 /* save the internal state, not used */
502 kmi_get_state(keyboard_t *kbd, void *buf, size_t len)
504 return (len == 0) ? 1 : -1;
507 /* set the internal state, not used */
509 kmi_set_state(keyboard_t *kbd, void *buf, size_t len)
515 kmi_poll(keyboard_t *kbd, int on)
517 struct kmi_softc *sc = kbd->kb_data;
521 sc->sc_flags |= KMI_FLAG_POLLING;
522 sc->sc_poll_thread = curthread;
524 sc->sc_flags &= ~KMI_FLAG_POLLING;
531 /* local functions */
534 kmi_set_leds(struct kmi_softc *sc, uint8_t leds)
539 /* start transfer, if not already started */
540 printf("Implement me: %s\n", __func__);
544 kmi_set_typematic(keyboard_t *kbd, int code)
546 static const int delays[] = {250, 500, 750, 1000};
547 static const int rates[] = {34, 38, 42, 46, 50, 55, 59, 63,
548 68, 76, 84, 92, 100, 110, 118, 126,
549 136, 152, 168, 184, 200, 220, 236, 252,
550 272, 304, 336, 368, 400, 440, 472, 504};
555 kbd->kb_delay1 = delays[(code >> 5) & 3];
556 kbd->kb_delay2 = rates[code & 0x1f];
560 static keyboard_switch_t kmisw = {
565 .test_if = &kmi_test_if,
566 .enable = &kmi_enable,
567 .disable = &kmi_disable,
570 .read_char = &kmi_read_char,
571 .check_char = &kmi_check_char,
574 .clear_state = &kmi_clear_state,
575 .get_state = &kmi_get_state,
576 .set_state = &kmi_set_state,
577 .get_fkeystr = &genkbd_get_fkeystr,
579 .diag = &genkbd_diag,
582 KEYBOARD_DRIVER(kmi, kmisw, kmi_configure);
585 pl050_kmi_intr(void *arg)
587 struct kmi_softc *sc = arg;
590 KMI_CTX_LOCK_ASSERT();
592 if ((sc->sc_flags & KMI_FLAG_POLLING) != 0)
595 if (KBD_IS_ACTIVE(&sc->sc_kbd) &&
596 KBD_IS_BUSY(&sc->sc_kbd)) {
597 /* let the callback function process the input */
598 (sc->sc_kbd.kb_callback.kc_func) (&sc->sc_kbd, KBDIO_KEYINPUT,
599 sc->sc_kbd.kb_callback.kc_arg);
601 /* read and discard the input, no one is waiting for it */
603 c = kmi_read_char_locked(&sc->sc_kbd, 0);
604 } while (c != NOKEY);
610 pl050_kmi_probe(device_t dev)
613 if (ofw_bus_is_compatible(dev, "arm,pl050")) {
614 device_set_desc(dev, "PL050 Keyboard/Mouse Interface");
615 return (BUS_PROBE_DEFAULT);
622 pl050_kmi_attach(device_t dev)
624 struct kmi_softc *sc = device_get_softc(dev);
632 sc->sc_mem_res = bus_alloc_resource_any(dev, SYS_RES_MEMORY, &rid, RF_ACTIVE);
633 if (sc->sc_mem_res == NULL) {
634 device_printf(dev, "could not allocate memory resource\n");
638 /* Request the IRQ resources */
639 sc->sc_irq_res = bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid, RF_ACTIVE);
640 if (sc->sc_irq_res == NULL) {
641 device_printf(dev, "Error: could not allocate irq resources\n");
645 /* Setup and enable the timer */
646 if (bus_setup_intr(dev, sc->sc_irq_res, INTR_TYPE_CLK,
647 NULL, pl050_kmi_intr, sc,
648 &sc->sc_intr_hl) != 0) {
649 bus_release_resource(dev, SYS_RES_IRQ, rid,
651 device_printf(dev, "Unable to setup the clock irq handler.\n");
655 /* TODO: clock & divisor */
657 pl050_kmi_write_4(sc, KMICR, KMICR_EN | KMICR_RXINTREN);
659 kbd_init_struct(kbd, KMI_DRIVER_NAME, KB_OTHER,
660 device_get_unit(dev), 0, 0, 0);
661 kbd->kb_data = (void *)sc;
663 sc->sc_keymap = key_map;
664 sc->sc_accmap = accent_map;
665 for (i = 0; i < KMI_NFKEY; i++) {
666 sc->sc_fkeymap[i] = fkey_tab[i];
669 kbd_set_maps(kbd, &sc->sc_keymap, &sc->sc_accmap,
670 sc->sc_fkeymap, KMI_NFKEY);
672 KBD_FOUND_DEVICE(kbd);
673 kmi_clear_state(kbd);
678 if (kbd_register(kbd) < 0) {
681 KBD_CONFIG_DONE(kbd);
683 #ifdef KBD_INSTALL_CDEV
684 if (kbd_attach(kbd)) {
690 genkbd_diag(kbd, bootverbose);
699 static device_method_t pl050_kmi_methods[] = {
700 DEVMETHOD(device_probe, pl050_kmi_probe),
701 DEVMETHOD(device_attach, pl050_kmi_attach),
705 static driver_t pl050_kmi_driver = {
708 sizeof(struct kmi_softc),
711 static devclass_t pl050_kmi_devclass;
713 DRIVER_MODULE(pl050_kmi, simplebus, pl050_kmi_driver, pl050_kmi_devclass, 0, 0);