Home | History | Annotate | Line # | Download | only in dev
zkbd.c revision 1.2 
      1 /*	$NetBSD: zkbd.c,v 1.2 2006/12/17 16:07:11 peter 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.2 2006/12/17 16:07:11 peter 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, caddr_t, 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 	return 1;
    170 }
    171 
    172 static void
    173 zkbd_attach(struct device *parent, struct device *self, void *aux)
    174 {
    175 	struct zkbd_softc *sc = (struct zkbd_softc *)self;
    176 	struct wskbddev_attach_args a;
    177 	int pin, i;
    178 
    179 	zkbd_sc = sc;
    180 	sc->sc_polling = 0;
    181 #ifdef WSDISPLAY_COMPAT_RAWKBD
    182 	sc->sc_rawkbd = 0;
    183 #endif
    184 	/* Determine which system we are - XXX */
    185 
    186 	sc->sc_powerhook = powerhook_establish(sc->sc_dev.dv_xname,
    187 	    zkbd_power, sc);
    188 	if (sc->sc_powerhook == NULL) {
    189 		printf(": unable to establish powerhook\n");
    190 		return;
    191 	}
    192 
    193 	if (1 /* C3000 */) {
    194 		sc->sc_sense_array = gpio_sense_pins_c3000;
    195 		sc->sc_strobe_array = gpio_strobe_pins_c3000;
    196 		sc->sc_nsense = __arraycount(gpio_sense_pins_c3000);
    197 		sc->sc_nstrobe = __arraycount(gpio_strobe_pins_c3000);
    198 		sc->sc_maxkbdcol = 10;
    199 		sc->sc_onkey_pin = 95;
    200 		sc->sc_sync_pin = 16;
    201 		sc->sc_swa_pin = 97;
    202 		sc->sc_swb_pin = 96;
    203 #ifdef WSDISPLAY_COMPAT_RAWKBD
    204 		sc->sc_xt_keymap = xt_keymap;
    205 #endif
    206 	} /* XXX */
    207 
    208 	sc->sc_okeystate = malloc(sc->sc_nsense * sc->sc_nstrobe,
    209 	    M_DEVBUF, M_NOWAIT);
    210 	memset(sc->sc_okeystate, 0, sc->sc_nsense * sc->sc_nstrobe);
    211 
    212 	sc->sc_keystate = malloc(sc->sc_nsense * sc->sc_nstrobe,
    213 	    M_DEVBUF, M_NOWAIT);
    214 	memset(sc->sc_keystate, 0, sc->sc_nsense * sc->sc_nstrobe);
    215 
    216 	/* set all the strobe bits */
    217 	for (i = 0; i < sc->sc_nstrobe; i++) {
    218 		pin = sc->sc_strobe_array[i];
    219 		if (pin == -1) {
    220 			continue;
    221 		}
    222 		pxa2x0_gpio_set_function(pin, GPIO_SET|GPIO_OUT);
    223 	}
    224 
    225 	/* set all the sense bits */
    226 	for (i = 0; i < sc->sc_nsense; i++) {
    227 		pin = sc->sc_sense_array[i];
    228 		if (pin == -1) {
    229 			continue;
    230 		}
    231 		pxa2x0_gpio_set_function(pin, GPIO_IN);
    232 		pxa2x0_gpio_intr_establish(pin, IST_EDGE_BOTH, IPL_TTY,
    233 		    zkbd_irq, sc);
    234 	}
    235 
    236 	pxa2x0_gpio_intr_establish(sc->sc_onkey_pin, IST_EDGE_BOTH, IPL_TTY,
    237 	    zkbd_on, sc);
    238 	pxa2x0_gpio_intr_establish(sc->sc_sync_pin, IST_EDGE_RISING, IPL_TTY,
    239 	    zkbd_sync, sc);
    240 	pxa2x0_gpio_intr_establish(sc->sc_swa_pin, IST_EDGE_BOTH, IPL_TTY,
    241 	    zkbd_hinge, sc);
    242 	pxa2x0_gpio_intr_establish(sc->sc_swb_pin, IST_EDGE_BOTH, IPL_TTY,
    243 	    zkbd_hinge, sc);
    244 
    245 	if (glass_console) {
    246 		wskbd_cnattach(&zkbd_consops, sc, &zkbd_keymapdata);
    247 		a.console = 1;
    248 	} else {
    249 		a.console = 0;
    250 	}
    251 	a.keymap = &zkbd_keymapdata;
    252 	a.accessops = &zkbd_accessops;
    253 	a.accesscookie = sc;
    254 
    255 	printf("\n");
    256 
    257 	zkbd_hinge(sc);		/* to initialize sc_hinge */
    258 
    259 	sc->sc_wskbddev = config_found(self, &a, wskbddevprint);
    260 
    261 	callout_init(&sc->sc_roll_to);
    262 	callout_setfunc(&sc->sc_roll_to, zkbd_poll, sc);
    263 #ifdef WSDISPLAY_COMPAT_RAWKBD
    264 	callout_setfunc(&sc->sc_rawrepeat_ch, zkbd_rawrepeat, sc);
    265 #endif
    266 }
    267 
    268 #ifdef WSDISPLAY_COMPAT_RAWKBD
    269 static void
    270 zkbd_rawrepeat(void *v)
    271 {
    272 	struct zkbd_softc *sc = (struct zkbd_softc *)v;
    273 	int s;
    274 
    275 	s = spltty();
    276 	wskbd_rawinput(sc->sc_wskbddev, sc->sc_rep, sc->sc_nrep);
    277 	splx(s);
    278 	callout_schedule(&sc->sc_rawrepeat_ch, hz * REP_DELAYN / 1000);
    279 }
    280 #endif
    281 
    282 /* XXX only deal with keys that can be pressed when display is open? */
    283 /* XXX are some not in the array? */
    284 /* handle keypress interrupt */
    285 static int
    286 zkbd_irq(void *v)
    287 {
    288 
    289 	zkbd_poll(v);
    290 
    291 	return 1;
    292 }
    293 
    294 static void
    295 zkbd_poll(void *v)
    296 {
    297 	struct zkbd_softc *sc = (struct zkbd_softc *)v;
    298 	int i, j, col, pin, type, keysdown = 0;
    299 	int stuck;
    300 	int keystate;
    301 	int s;
    302 #ifdef WSDISPLAY_COMPAT_RAWKBD
    303 	int npress = 0, ncbuf = 0, c;
    304 	char cbuf[MAXKEYS * 2];
    305 #endif
    306 
    307 	s = spltty();
    308 
    309 	/* discharge all */
    310 	for (i = 0; i < sc->sc_nstrobe; i++) {
    311 		pin = sc->sc_strobe_array[i];
    312 		if (pin != -1) {
    313 			pxa2x0_gpio_clear_bit(pin);
    314 			pxa2x0_gpio_set_dir(pin, GPIO_IN);
    315 		}
    316 	}
    317 
    318 	delay(10);
    319 	for (col = 0; col < sc->sc_nstrobe; col++) {
    320 		pin = sc->sc_strobe_array[col];
    321 		if (pin == -1)
    322 			continue;
    323 
    324 		/* activate_col */
    325 		pxa2x0_gpio_set_bit(pin);
    326 		pxa2x0_gpio_set_dir(pin, GPIO_OUT);
    327 
    328 		/* wait activate delay */
    329 		delay(10);
    330 
    331 		/* read row */
    332 		for (i = 0; i < sc->sc_nsense; i++) {
    333 			int bit;
    334 
    335 			if (sc->sc_sense_array[i] == -1)
    336 				continue;
    337 
    338 			bit = pxa2x0_gpio_get_bit(sc->sc_sense_array[i]);
    339 			if (bit && sc->sc_hinge && col < sc->sc_maxkbdcol)
    340 				continue;
    341 			sc->sc_keystate[i + (col * sc->sc_nsense)] = bit;
    342 		}
    343 
    344 		/* reset_col */
    345 		pxa2x0_gpio_set_dir(pin, GPIO_IN);
    346 
    347 		/* wait discharge delay */
    348 		delay(10);
    349 	}
    350 
    351 	/* charge all */
    352 	for (i = 0; i < sc->sc_nstrobe; i++) {
    353 		pin = sc->sc_strobe_array[i];
    354 		if (pin != -1) {
    355 			pxa2x0_gpio_set_bit(pin);
    356 			pxa2x0_gpio_set_dir(pin, GPIO_OUT);
    357 		}
    358 	}
    359 
    360 	/* force the irqs to clear as we have just played with them. */
    361 	for (i = 0; i < sc->sc_nsense; i++) {
    362 		if (sc->sc_sense_array[i] != -1) {
    363 			pxa2x0_gpio_clear_intr(sc->sc_sense_array[i]);
    364 		}
    365 	}
    366 
    367 	/* process after resetting interrupt */
    368 	zkbd_modstate = (
    369 		(sc->sc_keystate[84] ? (1 << 0) : 0) | /* shift */
    370 		(sc->sc_keystate[93] ? (1 << 1) : 0) | /* Fn */
    371 		(sc->sc_keystate[14] ? (1 << 2) : 0)); /* 'alt' */
    372 
    373 	for (i = 0; i < sc->sc_nsense * sc->sc_nstrobe; i++) {
    374 		stuck = 0;
    375 		/* extend  xt_keymap to do this faster. */
    376 		/* ignore 'stuck' keys' */
    377 		for (j = 0; j < __arraycount(stuck_keys); j++) {
    378 			if (stuck_keys[j] == i) {
    379 				stuck = 1;
    380 				break;
    381 			}
    382 		}
    383 		if (stuck)
    384 			continue;
    385 
    386 		keystate = sc->sc_keystate[i];
    387 		keysdown |= keystate; /* if any keys held */
    388 
    389 #ifdef WSDISPLAY_COMPAT_RAWKBD
    390 		if (sc->sc_polling == 0 && sc->sc_rawkbd) {
    391 			if ((keystate) || (sc->sc_okeystate[i] != keystate)) {
    392 				c = sc->sc_xt_keymap[i];
    393 				if (c & 0x80) {
    394 					cbuf[ncbuf++] = 0xe0;
    395 				}
    396 				cbuf[ncbuf] = c & 0x7f;
    397 
    398 				if (keystate) {
    399 					if (c & 0x80) {
    400 						sc->sc_rep[npress++] = 0xe0;
    401 					}
    402 					sc->sc_rep[npress++] = c & 0x7f;
    403 				} else {
    404 					cbuf[ncbuf] |= 0x80;
    405 				}
    406 				ncbuf++;
    407 				sc->sc_okeystate[i] = keystate;
    408 			}
    409 		}
    410 #endif
    411 
    412 		if ((!sc->sc_rawkbd) && (sc->sc_okeystate[i] != keystate)) {
    413 			type = keystate ? WSCONS_EVENT_KEY_DOWN :
    414 			    WSCONS_EVENT_KEY_UP;
    415 
    416 			if (sc->sc_polling) {
    417 				sc->sc_pollkey = i;
    418 				sc->sc_pollUD = type;
    419 			} else {
    420 				wskbd_input(sc->sc_wskbddev, type, i);
    421 			}
    422 
    423 			sc->sc_okeystate[i] = keystate;
    424 		}
    425 	}
    426 
    427 #ifdef WSDISPLAY_COMPAT_RAWKBD
    428 	if (sc->sc_polling == 0 && sc->sc_rawkbd) {
    429 		wskbd_rawinput(sc->sc_wskbddev, cbuf, ncbuf);
    430 		sc->sc_nrep = npress;
    431 		if (npress != 0)
    432 			callout_schedule(&sc->sc_rawrepeat_ch,
    433 			    hz * REP_DELAY1 / 1000);
    434 		else
    435 			callout_stop(&sc->sc_rawrepeat_ch);
    436 	}
    437 #endif
    438 	if (keysdown)
    439 		callout_schedule(&sc->sc_roll_to, hz * REP_DELAYN / 1000 / 2);
    440 	else
    441 		callout_stop(&sc->sc_roll_to);	/* always cancel? */
    442 
    443 	splx(s);
    444 }
    445 
    446 #if NAPM > 0
    447 extern	int kbd_reset;
    448 extern	int apm_suspends;
    449 static	int zkbdondown;				/* on key is pressed */
    450 static	struct timeval zkbdontv = { 0, 0 };	/* last on key event */
    451 const	struct timeval zkbdhalttv = { 3, 0 };	/*  3s for safe shutdown */
    452 const	struct timeval zkbdsleeptv = { 0, 250000 };	/* .25s for suspend */
    453 extern	int lid_suspend;
    454 #endif
    455 
    456 static int
    457 zkbd_on(void *v)
    458 {
    459 #if NAPM > 0
    460 	struct zkbd_softc *sc = (struct zkbd_softc *)v;
    461 	int down = pxa2x0_gpio_get_bit(sc->sc_onkey_pin) ? 1 : 0;
    462 
    463 	/*
    464 	 * Change run mode depending on how long the key is held down.
    465 	 * Ignore the key if it gets pressed while the lid is closed.
    466 	 *
    467 	 * Keys can bounce and we have to work around missed interrupts.
    468 	 * Only the second edge is detected upon exit from sleep mode.
    469 	 */
    470 	if (down) {
    471 		if (sc->sc_hinge == 3) {
    472 			zkbdondown = 0;
    473 		} else {
    474 			microuptime(&zkbdontv);
    475 			zkbdondown = 1;
    476 		}
    477 	} else if (zkbdondown) {
    478 		if (ratecheck(&zkbdontv, &zkbdhalttv)) {
    479 			if (kbd_reset == 1) {
    480 				kbd_reset = 0;
    481 				psignal(initproc, SIGUSR1);
    482 			}
    483 		} else if (ratecheck(&zkbdontv, &zkbdsleeptv)) {
    484 			apm_suspends++;
    485 		}
    486 		zkbdondown = 0;
    487 	}
    488 #endif
    489 	return 1;
    490 }
    491 
    492 static int
    493 zkbd_sync(void *v)
    494 {
    495 
    496 	return 1;
    497 }
    498 
    499 static int
    500 zkbd_hinge(void *v)
    501 {
    502 	struct zkbd_softc *sc = (struct zkbd_softc *)v;
    503 	int a = pxa2x0_gpio_get_bit(sc->sc_swa_pin) ? 1 : 0;
    504 	int b = pxa2x0_gpio_get_bit(sc->sc_swb_pin) ? 2 : 0;
    505 #if NLCD > 0
    506 	extern void lcd_blank(int);
    507 #endif
    508 
    509 	sc->sc_hinge = a | b;
    510 
    511 	if (sc->sc_hinge == 3) {
    512 #if NAPM > 0
    513 		if (lid_suspend)
    514 			apm_suspends++;
    515 #endif
    516 #if NLCD > 0
    517 		lcd_blank(1);
    518 #endif
    519 	} else {
    520 #if NLCD > 0
    521 		lcd_blank(0);
    522 #endif
    523 	}
    524 
    525 	return 1;
    526 }
    527 
    528 static int
    529 zkbd_enable(void *v, int on)
    530 {
    531 
    532 	return 0;
    533 }
    534 
    535 void
    536 zkbd_set_leds(void *v, int on)
    537 {
    538 }
    539 
    540 static int
    541 zkbd_ioctl(void *v, u_long cmd, caddr_t data, int flag, struct lwp *l)
    542 {
    543 #ifdef WSDISPLAY_COMPAT_RAWKBD
    544 	struct zkbd_softc *sc = (struct zkbd_softc *)v;
    545 #endif
    546 
    547 	switch (cmd) {
    548 	case WSKBDIO_GTYPE:
    549 		*(int *)data = WSKBD_TYPE_ZAURUS;
    550 		return 0;
    551 
    552 	case WSKBDIO_SETLEDS:
    553 		return 0;
    554 
    555 	case WSKBDIO_GETLEDS:
    556 		*(int *)data = 0;
    557 		return 0;
    558 
    559 #ifdef WSDISPLAY_COMPAT_RAWKBD
    560 	case WSKBDIO_SETMODE:
    561 		sc->sc_rawkbd = *(int *)data == WSKBD_RAW;
    562 		callout_stop(&sc->sc_rawrepeat_ch);
    563 		return 0;
    564 #endif
    565 
    566 	}
    567 	return EPASSTHROUGH;
    568 }
    569 
    570 /* implement polling for zaurus_kbd */
    571 static void
    572 zkbd_cngetc(void *v, u_int *type, int *data)
    573 {
    574 	struct zkbd_softc *sc = (struct zkbd_softc *)zkbd_sc;
    575 
    576 	sc->sc_pollkey = -1;
    577 	sc->sc_pollUD = -1;
    578 	sc->sc_polling = 1;
    579 	while (sc->sc_pollkey == -1) {
    580 		zkbd_poll(sc);
    581 		DELAY(10000);	/* XXX */
    582 	}
    583 	sc->sc_polling = 0;
    584 	*data = sc->sc_pollkey;
    585 	*type = sc->sc_pollUD;
    586 }
    587 
    588 static void
    589 zkbd_cnpollc(void *v, int on)
    590 {
    591 }
    592 
    593 static void
    594 zkbd_power(int why, void *arg)
    595 {
    596 
    597 	zkbd_hinge(arg);
    598 }
    599