Home | History | Annotate | Line # | Download | only in dev
pfckbd.c revision 1.25.14.1
      1 /*	$NetBSD: pfckbd.c,v 1.25.14.1 2009/05/13 17:17:47 jym Exp $	*/
      2 
      3 /*-
      4  * Copyright (c) 2001, 2002 The NetBSD Foundation, Inc.
      5  * All rights reserved.
      6  *
      7  * This code is derived from software contributed to The NetBSD Foundation
      8  * by UCHIYAMA Yasushi.
      9  *
     10  * Redistribution and use in source and binary forms, with or without
     11  * modification, are permitted provided that the following conditions
     12  * are met:
     13  * 1. Redistributions of source code must retain the above copyright
     14  *    notice, this list of conditions and the following disclaimer.
     15  * 2. Redistributions in binary form must reproduce the above copyright
     16  *    notice, this list of conditions and the following disclaimer in the
     17  *    documentation and/or other materials provided with the distribution.
     18  *
     19  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
     20  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
     21  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     22  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
     23  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
     24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
     25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     29  * POSSIBILITY OF SUCH DAMAGE.
     30  */
     31 
     32 /*
     33  * Matrix scan keyboard connected to SH7709, SH7709A PFC module.
     34  * currently, HP Jornada 680/690, HITACHI PERSONA HPW-50PAD only.
     35  */
     36 #include <sys/cdefs.h>
     37 __KERNEL_RCSID(0, "$NetBSD: pfckbd.c,v 1.25.14.1 2009/05/13 17:17:47 jym Exp $");
     38 
     39 #include "debug_hpcsh.h"
     40 
     41 #include <sys/param.h>
     42 #include <sys/systm.h>
     43 #include <sys/device.h>
     44 #include <sys/callout.h>
     45 
     46 #include <machine/bus.h>
     47 #include <machine/platid.h>
     48 #include <machine/platid_mask.h>
     49 
     50 #include <dev/hpc/hpckbdvar.h>
     51 
     52 #include <sh3/pfcreg.h>
     53 
     54 #include <hpcsh/dev/pfckbdvar.h>
     55 
     56 #ifdef	PFCKBD_DEBUG
     57 #define DPRINTF_ENABLE
     58 #define DPRINTF_DEBUG	pfckbd_debug
     59 #endif
     60 #include <machine/debug.h>
     61 
     62 static struct pfckbd_core {
     63 	int pc_attached;
     64 	int pc_enabled;
     65 	struct callout pc_soft_ch;
     66 	struct hpckbd_ic_if pc_if;
     67 	struct hpckbd_if *pc_hpckbd;
     68 	uint16_t pc_column[8];
     69 	void (*pc_callout)(void *);
     70 } pfckbd_core;
     71 
     72 static int pfckbd_match(device_t, cfdata_t, void *);
     73 static void pfckbd_attach(device_t, device_t, void *);
     74 
     75 CFATTACH_DECL_NEW(pfckbd, 0,
     76     pfckbd_match, pfckbd_attach, NULL, NULL);
     77 
     78 static void pfckbd_ifsetup(struct pfckbd_core *);
     79 
     80 /* callbacks for hpckbd */
     81 static int pfckbd_input_establish(void *, struct hpckbd_if *);
     82 static int pfckbd_poll(void *);
     83 
     84 static void pfckbd_input(struct pfckbd_core *, int, uint16_t);
     85 
     86 static void (*pfckbd_callout_lookup(void))(void *);
     87 static void pfckbd_callout_unknown(void *);
     88 static void pfckbd_callout_hp(void *);
     89 static void pfckbd_callout_hitachi(void *);
     90 void pfckbd_poll_hitachi_power(void);
     91 
     92 
     93 /* callout function table. this function is platfrom specific. */
     94 static const struct {
     95 	platid_mask_t *platform;
     96 	void (*func)(void *);
     97 } pfckbd_calloutfunc_table[] = {
     98 	{ &platid_mask_MACH_HP		, pfckbd_callout_hp },
     99 	{ &platid_mask_MACH_HITACHI	, pfckbd_callout_hitachi }
    100 };
    101 
    102 
    103 void
    104 pfckbd_cnattach(void)
    105 {
    106 	struct pfckbd_core *pc = &pfckbd_core;
    107 
    108 	if ((cpu_product != CPU_PRODUCT_7709)
    109 	    && (cpu_product != CPU_PRODUCT_7709A))
    110 		return;
    111 
    112 	/* initialize interface */
    113 	pfckbd_ifsetup(pc);
    114 
    115 	/* attach descendants */
    116 	hpckbd_cnattach(&pc->pc_if);
    117 }
    118 
    119 static int
    120 pfckbd_match(device_t parent, cfdata_t cf, void *aux)
    121 {
    122 
    123 	if ((cpu_product != CPU_PRODUCT_7709)
    124 	    && (cpu_product != CPU_PRODUCT_7709A))
    125 		return 0;
    126 
    127 	return !pfckbd_core.pc_attached; /* attach only once */
    128 }
    129 
    130 static void
    131 pfckbd_attach(device_t parent, device_t self, void *aux)
    132 {
    133 	struct hpckbd_attach_args haa;
    134 
    135 	aprint_naive("\n");
    136 	aprint_normal("\n");
    137 
    138 	pfckbd_core.pc_attached = 1;
    139 
    140 	pfckbd_ifsetup(&pfckbd_core);
    141 
    142 	/* attach hpckbd */
    143 	haa.haa_ic = &pfckbd_core.pc_if; /* tell hpckbd our interface */
    144 	config_found(self, &haa, hpckbd_print);
    145 
    146 	/* install callout handler */
    147 	callout_init(&pfckbd_core.pc_soft_ch, 0);
    148 	callout_reset(&pfckbd_core.pc_soft_ch, 1,
    149 		      pfckbd_core.pc_callout, &pfckbd_core);
    150 
    151 	if (!pmf_device_register(self, NULL, NULL))
    152 		aprint_error_dev(self, "unable to establish power handler\n");
    153 }
    154 
    155 static void
    156 pfckbd_ifsetup(struct pfckbd_core *pc)
    157 {
    158 	int i;
    159 
    160 	pc->pc_if.hii_ctx = pc;
    161 	pc->pc_if.hii_establish	= pfckbd_input_establish;
    162 	pc->pc_if.hii_poll = pfckbd_poll;
    163 
    164 	for (i = 0; i < 8; i++)
    165 		pc->pc_column[i] = 0xdfff;
    166 
    167 	/* select PFC access method */
    168 	pc->pc_callout = pfckbd_callout_lookup();
    169 }
    170 
    171 
    172 /*
    173  * Callback for hpckbd_initif
    174  */
    175 static int
    176 pfckbd_input_establish(void *ic, struct hpckbd_if *kbdif)
    177 {
    178 	struct pfckbd_core *pc = ic;
    179 
    180 	pc->pc_hpckbd = kbdif;	/* save hpckbd interface */
    181 	pc->pc_enabled = 1;	/* ok to talk to hpckbd */
    182 
    183 	return 0;
    184 }
    185 
    186 /*
    187  * Callback for hpckbd_cngetc
    188  */
    189 static int
    190 pfckbd_poll(void *ic)
    191 {
    192 	struct pfckbd_core *pc = ic;
    193 
    194 	if (pc->pc_enabled)
    195 		(*pc->pc_callout)(pc);
    196 
    197 	return 0;
    198 }
    199 
    200 /*
    201  * Called by platform specific scan routines to report key events to hpckbd
    202  */
    203 static void
    204 pfckbd_input(struct pfckbd_core *pc, int column, uint16_t data)
    205 {
    206 	int row, type, val;
    207 	unsigned int edge, mask;
    208 
    209 	edge = data ^ pc->pc_column[column];
    210 	if (edge == 0)
    211 		return;		/* no changes in this column */
    212 
    213 	pc->pc_column[column] = data;
    214 
    215 	for (row = 0, mask = 1; row < 16; ++row, mask <<= 1) {
    216 		if (mask & edge) {
    217 			type = mask & data ? /* up */ 0 : /* down */ 1;
    218 			DPRINTF("(%2d, %2d) %d \n", row, column, type);
    219 
    220 			val = row * 8 + column;
    221 			hpckbd_input(pc->pc_hpckbd, type, val);
    222 		}
    223 	}
    224 }
    225 
    226 
    227 /*
    228  * Platform dependent scan routines.
    229  */
    230 
    231 /* Look up appropriate callback handler */
    232 static void
    233 (*pfckbd_callout_lookup())(void *)
    234 {
    235 	int i, n;
    236 
    237 	n = sizeof(pfckbd_calloutfunc_table)
    238 		/ sizeof(pfckbd_calloutfunc_table[0]);
    239 
    240 	for (i = 0; i < n; i++)
    241 		if (platid_match(&platid,
    242 				 pfckbd_calloutfunc_table[i].platform))
    243 			return pfckbd_calloutfunc_table[i].func;
    244 
    245 	return pfckbd_callout_unknown;
    246 }
    247 
    248 /* Placeholder for unknown platform */
    249 static void
    250 pfckbd_callout_unknown(void *arg)
    251 {
    252 
    253 	printf("%s: unknown keyboard switch\n", __func__);
    254 }
    255 
    256 /*
    257  * HP Jornada680/690, HP620LX
    258  */
    259 static void
    260 pfckbd_callout_hp(void *arg)
    261 {
    262 #define PFCKBD_HP_PDCR_MASK 0xcc0c
    263 #define PFCKBD_HP_PECR_MASK 0xf0cf
    264 
    265 	/*
    266 	 * Disable output on all lines but the n'th line in D.
    267 	 * Pull the n'th scan line in D low.
    268 	 */
    269 #define PD(n)								\
    270 	{ (uint16_t)(PFCKBD_HP_PDCR_MASK & (~(1 << (2*(n)+1)))),	\
    271 	  (uint16_t)(PFCKBD_HP_PECR_MASK & 0xffff),			\
    272 	  (uint8_t)~(1 << (n)),						\
    273 	  0xff }
    274 
    275 	/* Ditto for E */
    276 #define PE(n)								\
    277 	{ (uint16_t)(PFCKBD_HP_PDCR_MASK & 0xffff),			\
    278 	  (uint16_t)(PFCKBD_HP_PECR_MASK & (~(1 << (2*(n)+1)))),	\
    279 	  0xff,								\
    280 	  (uint8_t)~(1 << (n)) }
    281 
    282 	static const struct {
    283 		uint16_t dc, ec; uint8_t d, e;
    284 	} scan[] = {
    285 		PD(1), PD(5), PE(1), PE(6), PE(7), PE(3), PE(0), PD(7)
    286 	};
    287 
    288 #undef PD
    289 #undef PE
    290 
    291 	struct pfckbd_core *pc = arg;
    292 	uint16_t dc, ec;
    293 	int column;
    294 	uint16_t data;
    295 
    296 	if (!pc->pc_enabled)
    297 		goto reinstall;
    298 
    299 	/* bits in D/E control regs we do not touch (XXX: can they change?) */
    300 	dc = _reg_read_2(SH7709_PDCR) & ~PFCKBD_HP_PDCR_MASK;
    301 	ec = _reg_read_2(SH7709_PECR) & ~PFCKBD_HP_PECR_MASK;
    302 
    303 	for (column = 0; column < 8; column++) {
    304 		/* disable output to all lines except the one we scan */
    305 		_reg_write_2(SH7709_PDCR, dc | scan[column].dc);
    306 		_reg_write_2(SH7709_PECR, ec | scan[column].ec);
    307 		delay(5);
    308 
    309 		/* pull the scan line low */
    310 		_reg_write_1(SH7709_PDDR, scan[column].d);
    311 		_reg_write_1(SH7709_PEDR, scan[column].e);
    312 		delay(50);
    313 
    314 		/* read sense */
    315 		data = _reg_read_1(SH7709_PFDR)
    316 			| (_reg_read_1(SH7709_PCDR) << 8);
    317 
    318 		pfckbd_input(pc, column, data);
    319 	}
    320 
    321 	/* scan no lines */
    322 	_reg_write_1(SH7709_PDDR, 0xff);
    323 	_reg_write_1(SH7709_PEDR, 0xff);
    324 
    325 	/* enable all scan lines */
    326 	_reg_write_2(SH7709_PDCR, dc | (0x5555 & PFCKBD_HP_PDCR_MASK));
    327 	_reg_write_2(SH7709_PECR, ec | (0x5555 & PFCKBD_HP_PECR_MASK));
    328 
    329 #if 0
    330 	/* (ignore) extra keys/events (recorder buttons, lid, cable &c) */
    331 	data = _reg_read_1(SH7709_PGDR) | (_reg_read_1(SH7709_PHDR) << 8);
    332 #endif
    333 
    334  reinstall:
    335 	callout_schedule(&pc->pc_soft_ch, 1);
    336 }
    337 
    338 /*
    339  * HITACH PERSONA (HPW-50PAD)
    340  */
    341 static void
    342 pfckbd_callout_hitachi(void *arg)
    343 {
    344 #define PFCKBD_HITACHI_PCCR_MASK 0xfff3
    345 #define PFCKBD_HITACHI_PDCR_MASK 0x000c
    346 #define PFCKBD_HITACHI_PECR_MASK 0x30cf
    347 
    348 #define PFCKBD_HITACHI_PCDR_SCN_MASK 0xfd
    349 #define PFCKBD_HITACHI_PDDR_SCN_MASK 0x02
    350 #define PFCKBD_HITACHI_PEDR_SCN_MASK 0x4b
    351 
    352 #define PFCKBD_HITACHI_PCDR_SNS_MASK 0x01
    353 #define PFCKBD_HITACHI_PFDR_SNS_MASK 0xfe
    354 
    355 	/*
    356 	 * Disable output on all lines but the n'th line in C.
    357 	 * Pull the n'th scan line in C low.
    358 	 */
    359 #define PC(n)								\
    360 	{ (uint16_t)(PFCKBD_HITACHI_PCCR_MASK & (~(1 << (2*(n)+1)))),	\
    361 	  (uint16_t)(PFCKBD_HITACHI_PDCR_MASK & 0xffff),		\
    362 	  (uint16_t)(PFCKBD_HITACHI_PECR_MASK & 0xffff),		\
    363 	  (uint8_t)(PFCKBD_HITACHI_PCDR_SCN_MASK & ~(1 << (n))),	\
    364 	  PFCKBD_HITACHI_PDDR_SCN_MASK,					\
    365 	  PFCKBD_HITACHI_PEDR_SCN_MASK }
    366 
    367 	/* Ditto for D */
    368 #define PD(n)								\
    369 	{ (uint16_t)(PFCKBD_HITACHI_PCCR_MASK & 0xffff),		\
    370 	  (uint16_t)(PFCKBD_HITACHI_PDCR_MASK & (~(1 << (2*(n)+1)))),	\
    371 	  (uint16_t)(PFCKBD_HITACHI_PECR_MASK & 0xffff),		\
    372 	  PFCKBD_HITACHI_PCDR_SCN_MASK,					\
    373 	  (uint8_t)(PFCKBD_HITACHI_PDDR_SCN_MASK & ~(1 << (n))),	\
    374 	  PFCKBD_HITACHI_PEDR_SCN_MASK }
    375 
    376 	/* Ditto for E */
    377 #define PE(n)								\
    378 	{ (uint16_t)(PFCKBD_HITACHI_PCCR_MASK & 0xffff),		\
    379 	  (uint16_t)(PFCKBD_HITACHI_PDCR_MASK & 0xffff),		\
    380 	  (uint16_t)(PFCKBD_HITACHI_PECR_MASK & (~(1 << (2*(n)+1)))),	\
    381 	  PFCKBD_HITACHI_PCDR_SCN_MASK,					\
    382 	  PFCKBD_HITACHI_PDDR_SCN_MASK,					\
    383 	  (uint8_t)(PFCKBD_HITACHI_PEDR_SCN_MASK & ~(1 << (n))) }
    384 
    385 	static const struct {
    386 		uint16_t cc, dc, ec; uint8_t c, d, e;
    387 	} scan[] = {
    388 		PE(6), PE(3), PE(1), PE(0), PC(7), PC(6), PC(5), PC(4),
    389 		PC(3), PC(2), PD(1), PC(0)
    390 	};
    391 
    392 	struct pfckbd_core *pc = arg;
    393 	uint16_t cc, dc, ec;
    394 	uint8_t data[2], cd, dd, ed;
    395 	int i;
    396 
    397 	if (!pc->pc_enabled)
    398 		goto reinstall;
    399 
    400 	/* bits in C/D/E control regs we do not touch (XXX: can they change?) */
    401 	cc = _reg_read_2(SH7709_PCCR) & ~PFCKBD_HITACHI_PCCR_MASK;
    402 	dc = _reg_read_2(SH7709_PDCR) & ~PFCKBD_HITACHI_PDCR_MASK;
    403 	ec = _reg_read_2(SH7709_PECR) & ~PFCKBD_HITACHI_PECR_MASK;
    404 
    405 	for (i = 0; i < 12; i++) {
    406 		/* disable output to all lines except the one we scan */
    407 		_reg_write_2(SH7709_PCCR, cc | scan[i].cc);
    408 		_reg_write_2(SH7709_PDCR, dc | scan[i].dc);
    409 		_reg_write_2(SH7709_PECR, ec | scan[i].ec);
    410 		delay(5);
    411 
    412 		cd = _reg_read_1(SH7709_PCDR) & ~PFCKBD_HITACHI_PCDR_SCN_MASK;
    413 		dd = _reg_read_1(SH7709_PDDR) & ~PFCKBD_HITACHI_PDDR_SCN_MASK;
    414 		ed = _reg_read_1(SH7709_PEDR) & ~PFCKBD_HITACHI_PEDR_SCN_MASK;
    415 
    416 		/* pull the scan line low */
    417 		_reg_write_1(SH7709_PCDR, cd | scan[i].c);
    418 		_reg_write_1(SH7709_PDDR, dd | scan[i].d);
    419 		_reg_write_1(SH7709_PEDR, ed | scan[i].e);
    420 		delay(50);
    421 
    422 		/* read sense */
    423 		data[i & 0x1] =
    424 		    (_reg_read_1(SH7709_PCDR) & PFCKBD_HITACHI_PCDR_SNS_MASK)
    425 		  | (_reg_read_1(SH7709_PFDR) & PFCKBD_HITACHI_PFDR_SNS_MASK);
    426 
    427 		if (i & 0x1)
    428 			pfckbd_input(pc, (i >> 1), (data[0] | (data[1] << 8)));
    429 	}
    430 
    431 	/* enable all scan lines */
    432 	_reg_write_2(SH7709_PCCR, cc | (0x5555 & PFCKBD_HITACHI_PCCR_MASK));
    433 	_reg_write_2(SH7709_PDCR, dc | (0x5555 & PFCKBD_HITACHI_PDCR_MASK));
    434 	_reg_write_2(SH7709_PECR, ec | (0x5555 & PFCKBD_HITACHI_PECR_MASK));
    435 
    436  reinstall:
    437 	callout_schedule(&pc->pc_soft_ch, 1);
    438 }
    439 
    440 void
    441 pfckbd_poll_hitachi_power(void)
    442 {
    443 	static const struct {
    444 		uint16_t cc, dc, ec; uint8_t c, d, e;
    445 	} poll = PD(1);
    446 
    447 #undef PC
    448 #undef PD
    449 #undef PE
    450 
    451 	uint16_t cc, dc, ec;
    452 	uint8_t cd, dd, ed;
    453 
    454 	/* bits in C/D/E control regs we do not touch (XXX: can they change?) */
    455 	cc = _reg_read_2(SH7709_PCCR) & ~PFCKBD_HITACHI_PCCR_MASK;
    456 	dc = _reg_read_2(SH7709_PDCR) & ~PFCKBD_HITACHI_PDCR_MASK;
    457 	ec = _reg_read_2(SH7709_PECR) & ~PFCKBD_HITACHI_PECR_MASK;
    458 
    459 	/* disable output to all lines except the one we scan */
    460 	_reg_write_2(SH7709_PCCR, cc | poll.cc);
    461 	_reg_write_2(SH7709_PDCR, dc | poll.dc);
    462 	_reg_write_2(SH7709_PECR, ec | poll.ec);
    463 	delay(5);
    464 
    465 	cd = _reg_read_1(SH7709_PCDR) & ~PFCKBD_HITACHI_PCDR_SCN_MASK;
    466 	dd = _reg_read_1(SH7709_PDDR) & ~PFCKBD_HITACHI_PDDR_SCN_MASK;
    467 	ed = _reg_read_1(SH7709_PEDR) & ~PFCKBD_HITACHI_PEDR_SCN_MASK;
    468 
    469 	/* pull the scan line low */
    470 	_reg_write_1(SH7709_PCDR, cd | poll.c);
    471 	_reg_write_1(SH7709_PDDR, dd | poll.d);
    472 	_reg_write_1(SH7709_PEDR, ed | poll.e);
    473 	delay(50);
    474 
    475 	/* poll POWER On */
    476 	while (_reg_read_1(SH7709_PCDR) & PFCKBD_HITACHI_PCDR_SNS_MASK & 0x01);
    477 
    478 	/* enable all scan lines */
    479 	_reg_write_2(SH7709_PCCR, cc | (0x5555 & PFCKBD_HITACHI_PCCR_MASK));
    480 	_reg_write_2(SH7709_PDCR, dc | (0x5555 & PFCKBD_HITACHI_PDCR_MASK));
    481 	_reg_write_2(SH7709_PECR, ec | (0x5555 & PFCKBD_HITACHI_PECR_MASK));
    482 }
    483