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