Home | History | Annotate | Line # | Download | only in dev
zkbd.c revision 1.4 
      1 /*	$NetBSD: zkbd.c,v 1.4 2007/06/28 15:31:04 nonaka Exp $	*/
      2 /* $OpenBSD: zaurus_kbd.c,v 1.28 2005/12/21 20:36:03 deraadt Exp $ */
      3 
      4 /*
      5  * Copyright (c) 2005 Dale Rahn <drahn (at) openbsd.org>
      6  *
      7  * Permission to use, copy, modify, and distribute this software for any
      8  * purpose with or without fee is hereby granted, provided that the above
      9  * copyright notice and this permission notice appear in all copies.
     10  *
     11  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
     12  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
     13  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
     14  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
     15  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
     16  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
     17  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
     18  */
     19 
     20 #include <sys/cdefs.h>
     21 __KERNEL_RCSID(0, "$NetBSD: zkbd.c,v 1.4 2007/06/28 15:31:04 nonaka Exp $");
     22 
     23 #include "opt_wsdisplay_compat.h"
     24 #include "lcd.h"
     25 #if 0	/* XXX */
     26 #include "apm.h"
     27 #endif
     28 
     29 #include <sys/param.h>
     30 #include <sys/systm.h>
     31 #include <sys/device.h>
     32 #include <sys/malloc.h>
     33 #include <sys/kernel.h>
     34 #include <sys/proc.h>
     35 #include <sys/signalvar.h>
     36 #include <sys/callout.h>
     37 
     38 #include <arm/xscale/pxa2x0reg.h>
     39 #include <arm/xscale/pxa2x0_gpio.h>
     40 
     41 #include <dev/wscons/wsconsio.h>
     42 #include <dev/wscons/wskbdvar.h>
     43 #include <dev/wscons/wsksymdef.h>
     44 #include <dev/wscons/wsksymvar.h>
     45 
     46 #include <zaurus/dev/zkbdmap.h>
     47 #include <zaurus/zaurus/zaurus_var.h>
     48 
     49 static const int gpio_sense_pins_c3000[] = {
     50 	12,
     51 	17,
     52 	91,
     53 	34,
     54 	36,
     55 	38,
     56 	39,
     57 	-1
     58 };
     59 
     60 static const int gpio_strobe_pins_c3000[] = {
     61 	88,
     62 	23,
     63 	24,
     64 	25,
     65 	26,
     66 	27,
     67 	52,
     68 	103,
     69 	107,
     70 	-1,
     71 	108,
     72 	114
     73 };
     74 
     75 static const int stuck_keys[] = {
     76 	7,
     77 	15,
     78 	23,
     79 	31
     80 };
     81 
     82 #define REP_DELAY1 400
     83 #define REP_DELAYN 100
     84 
     85 struct zkbd_softc {
     86 	struct device sc_dev;
     87 
     88 	const int *sc_sense_array;
     89 	const int *sc_strobe_array;
     90 	int sc_nsense;
     91 	int sc_nstrobe;
     92 
     93 	short sc_onkey_pin;
     94 	short sc_sync_pin;
     95 	short sc_swa_pin;
     96 	short sc_swb_pin;
     97 	char *sc_okeystate;
     98 	char *sc_keystate;
     99 	char sc_hinge;		/* 0=open, 1=nonsense, 2=backwards, 3=closed */
    100 	char sc_maxkbdcol;
    101 
    102 	struct callout sc_roll_to;
    103 
    104 	/* console stuff */
    105 	int sc_polling;
    106 	int sc_pollUD;
    107 	int sc_pollkey;
    108 
    109 	/* wskbd bits */
    110 	struct device *sc_wskbddev;
    111 	int sc_rawkbd;
    112 #ifdef WSDISPLAY_COMPAT_RAWKBD
    113 	const char *sc_xt_keymap;
    114 	struct callout sc_rawrepeat_ch;
    115 #define MAXKEYS 20
    116 	char sc_rep[MAXKEYS];
    117 	int sc_nrep;
    118 #endif
    119 	void *sc_powerhook;
    120 };
    121 
    122 static struct zkbd_softc *zkbd_sc;
    123 
    124 static int	zkbd_match(struct device *, struct cfdata *, void *);
    125 static void	zkbd_attach(struct device *, struct device *, void *);
    126 
    127 CFATTACH_DECL(zkbd, sizeof(struct zkbd_softc),
    128 	zkbd_match, zkbd_attach, NULL, NULL);
    129 
    130 static int	zkbd_irq(void *v);
    131 static void	zkbd_poll(void *v);
    132 static int	zkbd_on(void *v);
    133 static int	zkbd_sync(void *v);
    134 static int	zkbd_hinge(void *v);
    135 static void	zkbd_power(int why, void *arg);
    136 
    137 int zkbd_modstate;
    138 
    139 static int	zkbd_enable(void *, int);
    140 static void	zkbd_set_leds(void *, int);
    141 static int	zkbd_ioctl(void *, u_long, void *, int, struct lwp *);
    142 #ifdef WSDISPLAY_COMPAT_RAWKBD
    143 static void	zkbd_rawrepeat(void *v);
    144 #endif
    145 
    146 static struct wskbd_accessops zkbd_accessops = {
    147 	zkbd_enable,
    148 	zkbd_set_leds,
    149 	zkbd_ioctl,
    150 };
    151 
    152 static void	zkbd_cngetc(void *, u_int *, int *);
    153 static void	zkbd_cnpollc(void *, int);
    154 
    155 static struct wskbd_consops zkbd_consops = {
    156 	zkbd_cngetc,
    157 	zkbd_cnpollc,
    158 };
    159 
    160 static struct wskbd_mapdata zkbd_keymapdata = {
    161 	zkbd_keydesctab,
    162 	KB_US,
    163 };
    164 
    165 static int
    166 zkbd_match(struct device *parent, struct cfdata *cf, void *aux)
    167 {
    168 
    169 	if (zkbd_sc)
    170 		return 0;
    171 
    172 	return 1;
    173 }
    174 
    175 static void
    176 zkbd_attach(struct device *parent, struct device *self, void *aux)
    177 {
    178 	struct zkbd_softc *sc = (struct zkbd_softc *)self;
    179 	struct wskbddev_attach_args a;
    180 	int pin, i;
    181 
    182 	zkbd_sc = sc;
    183 
    184 	printf("\n");
    185 
    186 	sc->sc_polling = 0;
    187 #ifdef WSDISPLAY_COMPAT_RAWKBD
    188 	sc->sc_rawkbd = 0;
    189 #endif
    190 
    191 	if (ZAURUS_ISC3000) {
    192 		sc->sc_sense_array = gpio_sense_pins_c3000;
    193 		sc->sc_strobe_array = gpio_strobe_pins_c3000;
    194 		sc->sc_nsense = __arraycount(gpio_sense_pins_c3000);
    195 		sc->sc_nstrobe = __arraycount(gpio_strobe_pins_c3000);
    196 		sc->sc_maxkbdcol = 10;
    197 		sc->sc_onkey_pin = 95;
    198 		sc->sc_sync_pin = 16;
    199 		sc->sc_swa_pin = 97;
    200 		sc->sc_swb_pin = 96;
    201 #ifdef WSDISPLAY_COMPAT_RAWKBD
    202 		sc->sc_xt_keymap = xt_keymap;
    203 #endif
    204 	} else {
    205 		/* XXX */
    206 		return;
    207 	}
    208 
    209 	sc->sc_powerhook = powerhook_establish(sc->sc_dev.dv_xname,
    210 	    zkbd_power, sc);
    211 	if (sc->sc_powerhook == NULL) {
    212 		printf("%s: unable to establish powerhook\n",
    213 		    sc->sc_dev.dv_xname);
    214 		return;
    215 	}
    216 
    217 	sc->sc_okeystate = malloc(sc->sc_nsense * sc->sc_nstrobe,
    218 	    M_DEVBUF, M_NOWAIT);
    219 	memset(sc->sc_okeystate, 0, sc->sc_nsense * sc->sc_nstrobe);
    220 
    221 	sc->sc_keystate = malloc(sc->sc_nsense * sc->sc_nstrobe,
    222 	    M_DEVBUF, M_NOWAIT);
    223 	memset(sc->sc_keystate, 0, sc->sc_nsense * sc->sc_nstrobe);
    224 
    225 	/* set all the strobe bits */
    226 	for (i = 0; i < sc->sc_nstrobe; i++) {
    227 		pin = sc->sc_strobe_array[i];
    228 		if (pin == -1)
    229 			continue;
    230 		pxa2x0_gpio_set_function(pin, GPIO_SET|GPIO_OUT);
    231 	}
    232 
    233 	/* set all the sense bits */
    234 	for (i = 0; i < sc->sc_nsense; i++) {
    235 		pin = sc->sc_sense_array[i];
    236 		if (pin == -1)
    237 			continue;
    238 		pxa2x0_gpio_set_function(pin, GPIO_IN);
    239 		pxa2x0_gpio_intr_establish(pin, IST_EDGE_BOTH, IPL_TTY,
    240 		    zkbd_irq, sc);
    241 	}
    242 
    243 	pxa2x0_gpio_intr_establish(sc->sc_onkey_pin, IST_EDGE_BOTH, IPL_TTY,
    244 	    zkbd_on, sc);
    245 	pxa2x0_gpio_intr_establish(sc->sc_sync_pin, IST_EDGE_RISING, IPL_TTY,
    246 	    zkbd_sync, sc);
    247 	pxa2x0_gpio_intr_establish(sc->sc_swa_pin, IST_EDGE_BOTH, IPL_TTY,
    248 	    zkbd_hinge, sc);
    249 	pxa2x0_gpio_intr_establish(sc->sc_swb_pin, IST_EDGE_BOTH, IPL_TTY,
    250 	    zkbd_hinge, sc);
    251 
    252 	if (glass_console) {
    253 		wskbd_cnattach(&zkbd_consops, sc, &zkbd_keymapdata);
    254 		a.console = 1;
    255 	} else {
    256 		a.console = 0;
    257 	}
    258 	a.keymap = &zkbd_keymapdata;
    259 	a.accessops = &zkbd_accessops;
    260 	a.accesscookie = sc;
    261 
    262 	zkbd_hinge(sc);		/* to initialize sc_hinge */
    263 
    264 	sc->sc_wskbddev = config_found(self, &a, wskbddevprint);
    265 
    266 	callout_init(&sc->sc_roll_to);
    267 	callout_setfunc(&sc->sc_roll_to, zkbd_poll, sc);
    268 #ifdef WSDISPLAY_COMPAT_RAWKBD
    269 	callout_setfunc(&sc->sc_rawrepeat_ch, zkbd_rawrepeat, sc);
    270 #endif
    271 }
    272 
    273 #ifdef WSDISPLAY_COMPAT_RAWKBD
    274 static void
    275 zkbd_rawrepeat(void *v)
    276 {
    277 	struct zkbd_softc *sc = (struct zkbd_softc *)v;
    278 	int s;
    279 
    280 	s = spltty();
    281 	wskbd_rawinput(sc->sc_wskbddev, sc->sc_rep, sc->sc_nrep);
    282 	splx(s);
    283 	callout_schedule(&sc->sc_rawrepeat_ch, hz * REP_DELAYN / 1000);
    284 }
    285 #endif
    286 
    287 /* XXX only deal with keys that can be pressed when display is open? */
    288 /* XXX are some not in the array? */
    289 /* handle keypress interrupt */
    290 static int
    291 zkbd_irq(void *v)
    292 {
    293 
    294 	zkbd_poll(v);
    295 
    296 	return 1;
    297 }
    298 
    299 static void
    300 zkbd_poll(void *v)
    301 {
    302 	struct zkbd_softc *sc = (struct zkbd_softc *)v;
    303 	int i, j, col, pin, type, keysdown = 0;
    304 	int stuck;
    305 	int keystate;
    306 	int s;
    307 #ifdef WSDISPLAY_COMPAT_RAWKBD
    308 	int npress = 0, ncbuf = 0, c;
    309 	char cbuf[MAXKEYS * 2];
    310 #endif
    311 
    312 	s = spltty();
    313 
    314 	/* discharge all */
    315 	for (i = 0; i < sc->sc_nstrobe; i++) {
    316 		pin = sc->sc_strobe_array[i];
    317 		if (pin == -1)
    318 			continue;
    319 		pxa2x0_gpio_clear_bit(pin);
    320 		pxa2x0_gpio_set_dir(pin, GPIO_IN);
    321 	}
    322 
    323 	delay(10);
    324 	for (col = 0; col < sc->sc_nstrobe; col++) {
    325 		pin = sc->sc_strobe_array[col];
    326 		if (pin == -1)
    327 			continue;
    328 
    329 		/* activate_col */
    330 		pxa2x0_gpio_set_bit(pin);
    331 		pxa2x0_gpio_set_dir(pin, GPIO_OUT);
    332 
    333 		/* wait activate delay */
    334 		delay(10);
    335 
    336 		/* read row */
    337 		for (i = 0; i < sc->sc_nsense; i++) {
    338 			int bit;
    339 
    340 			if (sc->sc_sense_array[i] == -1)
    341 				continue;
    342 			bit = pxa2x0_gpio_get_bit(sc->sc_sense_array[i]);
    343 			if (bit && sc->sc_hinge && col < sc->sc_maxkbdcol)
    344 				continue;
    345 			sc->sc_keystate[i + (col * sc->sc_nsense)] = bit;
    346 		}
    347 
    348 		/* reset_col */
    349 		pxa2x0_gpio_set_dir(pin, GPIO_IN);
    350 
    351 		/* wait discharge delay */
    352 		delay(10);
    353 	}
    354 
    355 	/* charge all */
    356 	for (i = 0; i < sc->sc_nstrobe; i++) {
    357 		pin = sc->sc_strobe_array[i];
    358 		if (pin == -1)
    359 			continue;
    360 		pxa2x0_gpio_set_bit(pin);
    361 		pxa2x0_gpio_set_dir(pin, GPIO_OUT);
    362 	}
    363 
    364 	/* force the irqs to clear as we have just played with them. */
    365 	for (i = 0; i < sc->sc_nsense; i++) {
    366 		pin = sc->sc_sense_array[i];
    367 		if (pin == -1)
    368 			continue;
    369 		pxa2x0_gpio_clear_intr(pin);
    370 	}
    371 
    372 	/* process after resetting interrupt */
    373 	zkbd_modstate = (
    374 		(sc->sc_keystate[84] ? (1 << 0) : 0) | /* shift */
    375 		(sc->sc_keystate[93] ? (1 << 1) : 0) | /* Fn */
    376 		(sc->sc_keystate[14] ? (1 << 2) : 0)); /* 'alt' */
    377 
    378 	for (i = 0; i < sc->sc_nsense * sc->sc_nstrobe; i++) {
    379 		stuck = 0;
    380 		/* extend  xt_keymap to do this faster. */
    381 		/* ignore 'stuck' keys' */
    382 		for (j = 0; j < __arraycount(stuck_keys); j++) {
    383 			if (stuck_keys[j] == i) {
    384 				stuck = 1;
    385 				break;
    386 			}
    387 		}
    388 		if (stuck)
    389 			continue;
    390 
    391 		keystate = sc->sc_keystate[i];
    392 		keysdown |= keystate; /* if any keys held */
    393 
    394 #ifdef WSDISPLAY_COMPAT_RAWKBD
    395 		if (sc->sc_polling == 0 && sc->sc_rawkbd) {
    396 			if ((keystate) || (sc->sc_okeystate[i] != keystate)) {
    397 				c = sc->sc_xt_keymap[i];
    398 				if (c & 0x80) {
    399 					cbuf[ncbuf++] = 0xe0;
    400 				}
    401 				cbuf[ncbuf] = c & 0x7f;
    402 
    403 				if (keystate) {
    404 					if (c & 0x80) {
    405 						sc->sc_rep[npress++] = 0xe0;
    406 					}
    407 					sc->sc_rep[npress++] = c & 0x7f;
    408 				} else {
    409 					cbuf[ncbuf] |= 0x80;
    410 				}
    411 				ncbuf++;
    412 				sc->sc_okeystate[i] = keystate;
    413 			}
    414 		}
    415 #endif
    416 
    417 		if ((!sc->sc_rawkbd) && (sc->sc_okeystate[i] != keystate)) {
    418 			type = keystate ? WSCONS_EVENT_KEY_DOWN :
    419 			    WSCONS_EVENT_KEY_UP;
    420 
    421 			if (sc->sc_polling) {
    422 				sc->sc_pollkey = i;
    423 				sc->sc_pollUD = type;
    424 			} else {
    425 				wskbd_input(sc->sc_wskbddev, type, i);
    426 			}
    427 
    428 			sc->sc_okeystate[i] = keystate;
    429 		}
    430 	}
    431 
    432 #ifdef WSDISPLAY_COMPAT_RAWKBD
    433 	if (sc->sc_polling == 0 && sc->sc_rawkbd) {
    434 		wskbd_rawinput(sc->sc_wskbddev, cbuf, ncbuf);
    435 		sc->sc_nrep = npress;
    436 		if (npress != 0)
    437 			callout_schedule(&sc->sc_rawrepeat_ch,
    438 			    hz * REP_DELAY1 / 1000);
    439 		else
    440 			callout_stop(&sc->sc_rawrepeat_ch);
    441 	}
    442 #endif
    443 	if (keysdown)
    444 		callout_schedule(&sc->sc_roll_to, hz * REP_DELAYN / 1000 / 2);
    445 	else
    446 		callout_stop(&sc->sc_roll_to);	/* always cancel? */
    447 
    448 	splx(s);
    449 }
    450 
    451 #if NAPM > 0
    452 extern	int kbd_reset;
    453 extern	int apm_suspends;
    454 static	int zkbdondown;				/* on key is pressed */
    455 static	struct timeval zkbdontv = { 0, 0 };	/* last on key event */
    456 const	struct timeval zkbdhalttv = { 3, 0 };	/*  3s for safe shutdown */
    457 const	struct timeval zkbdsleeptv = { 0, 250000 };	/* .25s for suspend */
    458 extern	int lid_suspend;
    459 #endif
    460 
    461 static int
    462 zkbd_on(void *v)
    463 {
    464 #if NAPM > 0
    465 	struct zkbd_softc *sc = (struct zkbd_softc *)v;
    466 	int down = pxa2x0_gpio_get_bit(sc->sc_onkey_pin) ? 1 : 0;
    467 
    468 	/*
    469 	 * Change run mode depending on how long the key is held down.
    470 	 * Ignore the key if it gets pressed while the lid is closed.
    471 	 *
    472 	 * Keys can bounce and we have to work around missed interrupts.
    473 	 * Only the second edge is detected upon exit from sleep mode.
    474 	 */
    475 	if (down) {
    476 		if (sc->sc_hinge == 3) {
    477 			zkbdondown = 0;
    478 		} else {
    479 			microuptime(&zkbdontv);
    480 			zkbdondown = 1;
    481 		}
    482 	} else if (zkbdondown) {
    483 		if (ratecheck(&zkbdontv, &zkbdhalttv)) {
    484 			if (kbd_reset == 1) {
    485 				kbd_reset = 0;
    486 				psignal(initproc, SIGUSR1);
    487 			}
    488 		} else if (ratecheck(&zkbdontv, &zkbdsleeptv)) {
    489 			apm_suspends++;
    490 		}
    491 		zkbdondown = 0;
    492 	}
    493 #endif
    494 	return 1;
    495 }
    496 
    497 static int
    498 zkbd_sync(void *v)
    499 {
    500 
    501 	return 1;
    502 }
    503 
    504 static int
    505 zkbd_hinge(void *v)
    506 {
    507 	struct zkbd_softc *sc = (struct zkbd_softc *)v;
    508 	int a = pxa2x0_gpio_get_bit(sc->sc_swa_pin) ? 1 : 0;
    509 	int b = pxa2x0_gpio_get_bit(sc->sc_swb_pin) ? 2 : 0;
    510 #if NLCD > 0
    511 	extern void lcd_blank(int);
    512 #endif
    513 
    514 	sc->sc_hinge = a | b;
    515 
    516 	if (sc->sc_hinge == 3) {
    517 #if NAPM > 0
    518 		if (lid_suspend)
    519 			apm_suspends++;
    520 #endif
    521 #if NLCD > 0
    522 		lcd_blank(1);
    523 #endif
    524 	} else {
    525 #if NLCD > 0
    526 		lcd_blank(0);
    527 #endif
    528 	}
    529 
    530 	return 1;
    531 }
    532 
    533 static int
    534 zkbd_enable(void *v, int on)
    535 {
    536 
    537 	return 0;
    538 }
    539 
    540 void
    541 zkbd_set_leds(void *v, int on)
    542 {
    543 }
    544 
    545 static int
    546 zkbd_ioctl(void *v, u_long cmd, void *data, int flag, struct lwp *l)
    547 {
    548 #ifdef WSDISPLAY_COMPAT_RAWKBD
    549 	struct zkbd_softc *sc = (struct zkbd_softc *)v;
    550 #endif
    551 
    552 	switch (cmd) {
    553 	case WSKBDIO_GTYPE:
    554 		*(int *)data = WSKBD_TYPE_ZAURUS;
    555 		return 0;
    556 
    557 	case WSKBDIO_SETLEDS:
    558 		return 0;
    559 
    560 	case WSKBDIO_GETLEDS:
    561 		*(int *)data = 0;
    562 		return 0;
    563 
    564 #ifdef WSDISPLAY_COMPAT_RAWKBD
    565 	case WSKBDIO_SETMODE:
    566 		sc->sc_rawkbd = *(int *)data == WSKBD_RAW;
    567 		callout_stop(&sc->sc_rawrepeat_ch);
    568 		return 0;
    569 #endif
    570 
    571 	}
    572 	return EPASSTHROUGH;
    573 }
    574 
    575 /* implement polling for zaurus_kbd */
    576 static void
    577 zkbd_cngetc(void *v, u_int *type, int *data)
    578 {
    579 	struct zkbd_softc *sc = (struct zkbd_softc *)zkbd_sc;
    580 
    581 	sc->sc_pollkey = -1;
    582 	sc->sc_pollUD = -1;
    583 	sc->sc_polling = 1;
    584 	while (sc->sc_pollkey == -1) {
    585 		zkbd_poll(sc);
    586 		DELAY(10000);	/* XXX */
    587 	}
    588 	sc->sc_polling = 0;
    589 	*data = sc->sc_pollkey;
    590 	*type = sc->sc_pollUD;
    591 }
    592 
    593 static void
    594 zkbd_cnpollc(void *v, int on)
    595 {
    596 }
    597 
    598 static void
    599 zkbd_power(int why, void *arg)
    600 {
    601 
    602 	zkbd_hinge(arg);
    603 }
    604