xref: /netbsd-src/sys/arch/hpcsh/dev/pfckbd.c (revision 5e4c038a45edbc7d63b7c2daa76e29f88b64a4e3)
1 /*	$NetBSD: pfckbd.c,v 1.7 2002/02/28 01:56:59 uch 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 #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 int pfckbd_match(struct device *, struct cfdata *, void *);
63 STATIC void pfckbd_attach(struct device *, struct device *, void *);
64 STATIC void (*pfckbd_callout_lookup(void))(void *);
65 STATIC void pfckbd_callout_unknown(void *);
66 STATIC void pfckbd_callout_hp(void *);
67 STATIC void pfckbd_callout_hitachi(void *);
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 	u_int16_t pc_column[8];
76 	void (*pc_callout)(void *);
77 } pfckbd_core;
78 
79 /* callout function table. this function is platfrom specific. */
80 STATIC const struct {
81 	platid_mask_t *platform;
82 	void (*func)(void *);
83 } pfckbd_calloutfunc_table[] = {
84 	{ &platid_mask_MACH_HP		, pfckbd_callout_hp },
85 	{ &platid_mask_MACH_HITACHI	, pfckbd_callout_hitachi }
86 };
87 
88 struct cfattach pfckbd_ca = {
89 	sizeof(struct device), pfckbd_match, pfckbd_attach
90 };
91 
92 STATIC int pfckbd_poll(void *);
93 STATIC void pfckbd_ifsetup(struct pfckbd_core *);
94 STATIC int pfckbd_input_establish(void *, struct hpckbd_if *);
95 STATIC void pfckbd_input(struct hpckbd_if *, u_int16_t *, u_int16_t, int);
96 
97 /*
98  * Matrix scan keyboard connected to SH7709, SH7709A PFC module.
99  * currently, HP Jornada 680/690, HITACHI PERSONA HPW-50PAD only.
100  */
101 void
102 pfckbd_cnattach()
103 {
104 	struct pfckbd_core *pc = &pfckbd_core;
105 
106 	if ((cpu_product != CPU_PRODUCT_7709) &&
107 	    (cpu_product != CPU_PRODUCT_7709A))
108 		return;
109 
110 	/* initialize interface */
111 	pfckbd_ifsetup(pc);
112 
113 	/* attach console */
114 	hpckbd_cnattach(&pc->pc_if);
115 }
116 
117 int
118 pfckbd_match(struct device *parent, struct cfdata *cf, void *aux)
119 {
120 
121 	if ((cpu_product != CPU_PRODUCT_7709) &&
122 	    (cpu_product != CPU_PRODUCT_7709A))
123 		return (0);
124 
125 	return (!pfckbd_core.pc_attached);
126 }
127 
128 void
129 pfckbd_attach(struct device *parent, struct device *self, void *aux)
130 {
131 	struct hpckbd_attach_args haa;
132 
133 	printf("\n");
134 
135 	/* pfckbd is singleton. no more attach */
136 	pfckbd_core.pc_attached = 1;
137 	pfckbd_ifsetup(&pfckbd_core);
138 
139 	/* attach hpckbd */
140 	haa.haa_ic = &pfckbd_core.pc_if; /* tell the hpckbd to my interface */
141 	config_found(self, &haa, hpckbd_print);
142 
143 	/* install callout handler */
144 	callout_init(&pfckbd_core.pc_soft_ch);
145 	callout_reset(&pfckbd_core.pc_soft_ch, 1, pfckbd_core.pc_callout,
146 	    &pfckbd_core);
147 }
148 
149 int
150 pfckbd_input_establish(void *ic, struct hpckbd_if *kbdif)
151 {
152 	struct pfckbd_core *pc = ic;
153 
154 	/* save hpckbd interface */
155 	pc->pc_hpckbd = kbdif;
156 	/* ok to transact hpckbd */
157 	pc->pc_enabled = 1;
158 
159 	return 0;
160 }
161 
162 int
163 pfckbd_poll(void *arg)
164 {
165 	struct pfckbd_core *pc = arg;
166 
167 	if (pc->pc_enabled)
168 		(*pc->pc_callout)(arg);
169 
170 	return 0;
171 }
172 
173 void
174 pfckbd_ifsetup(struct pfckbd_core *pc)
175 {
176 	int i;
177 
178 	pc->pc_if.hii_ctx = pc;
179 	pc->pc_if.hii_establish	= pfckbd_input_establish;
180 	pc->pc_if.hii_poll = pfckbd_poll;
181 	for (i = 0; i < 8; i++)
182 		pc->pc_column[i] = 0xdfff;
183 
184 	/* select PFC access method */
185 	pc->pc_callout = pfckbd_callout_lookup();
186 }
187 
188 void
189 pfckbd_input(struct hpckbd_if *hpckbd, u_int16_t *buf, u_int16_t data,
190     int column)
191 {
192 	int row, type, val;
193 	u_int16_t edge, mask;
194 
195 	if ((edge = (data ^ buf[column]))) {
196 		buf[column] = data;
197 
198 		for (row = 0, mask = 1; row < 16; row++, mask <<= 1) {
199 			if (mask & edge) {
200 				type = mask & data ? 0 : 1;
201 				val = row * 8 + column;
202 				DPRINTF("(%2d, %2d) %d \n",
203 				    row, column, type);
204 				hpckbd_input(hpckbd, type, val);
205 			}
206 		}
207 	}
208 }
209 
210 /*
211  * Platform dependent routines.
212  */
213 
214 /* Look up appropriate callback handler */
215 void (*pfckbd_callout_lookup())(void *)
216 {
217 	int i, n = sizeof(pfckbd_calloutfunc_table) /
218 	    sizeof(pfckbd_calloutfunc_table[0]);
219 
220 	for (i = 0; i < n; i++)
221 		if (platid_match(&platid,
222 		    pfckbd_calloutfunc_table[i].platform))
223 			return (pfckbd_calloutfunc_table[i].func);
224 
225 	return (pfckbd_callout_unknown);
226 }
227 
228 /* Placeholder for unknown platform */
229 void
230 pfckbd_callout_unknown(void *arg)
231 {
232 
233 	printf("%s: unknown keyboard switch\n", __FUNCTION__);
234 }
235 
236 /* HP Jornada680/690, HP620LX */
237 void
238 pfckbd_callout_hp(void *arg)
239 {
240 	static const struct {
241 		u_int8_t d, e;
242 	} scan[] = {
243 		{ 0xfd, 0xff },
244 		{ 0xdf, 0xff },
245 		{ 0xff, 0xfd },
246 		{ 0xff, 0xbf },
247 		{ 0xff, 0x7f },
248 		{ 0xff, 0xf7 },
249 		{ 0xff, 0xfe },
250 		{ 0x7f, 0xff },
251 	};
252 	struct pfckbd_core *pc = arg;
253 	int column;
254 	u_int16_t data;
255 
256 	if (!pc->pc_enabled)
257 		goto reinstall;
258 
259 	for (column = 0; column < 8; column++) {
260 		_reg_write_1(SH7709_PDDR, scan[column].d);
261 		_reg_write_1(SH7709_PEDR, scan[column].e);
262 		delay(50);
263 		data = _reg_read_1(SH7709_PFDR) |
264 		    (_reg_read_1(SH7709_PCDR) << 8);
265 
266 		pfckbd_input(pc->pc_hpckbd, pc->pc_column, data, column);
267 	}
268 
269 	_reg_write_1(SH7709_PDDR, 0xff);
270 	_reg_write_1(SH7709_PEDR, 0xff);
271 	data = _reg_read_1(SH7709_PGDR) | (_reg_read_1(SH7709_PHDR) << 8);
272 
273  reinstall:
274 	callout_reset(&pc->pc_soft_ch, 1, pfckbd_callout_hp, pc);
275 }
276 
277 /* HITACH PERSONA (HPW-50PAD) */
278 void
279 pfckbd_callout_hitachi(void *arg)
280 {
281 	static const struct {
282 		u_int8_t d, e;
283 	} scan[] = {
284 		{ 0xf5, 0xff },
285 		{ 0xd7, 0xff },
286 		{ 0xf7, 0xfd },
287 		{ 0xf7, 0xbf },
288 		{ 0xf7, 0x7f },
289 		{ 0xf7, 0xf7 },
290 		{ 0xf7, 0xfe },
291 		{ 0x77, 0xff },
292 	};
293 	struct pfckbd_core *pc = arg;
294 	u_int16_t data;
295 	int column;
296 
297 	if (!pc->pc_enabled)
298 		goto reinstall;
299 
300 	for (column = 0; column < 8; column++) {
301 		_reg_write_1(SH7709_PCDR, ~(1 << column));
302 		delay(50);
303 		data = ((_reg_read_1(SH7709_PFDR) & 0xfe) |
304 		    (_reg_read_1(SH7709_PCDR) & 0x01)) << 8;
305 		_reg_write_1(SH7709_PCDR, 0xff);
306 		_reg_write_1(SH7709_PDDR, scan[column].d);
307 		_reg_write_1(SH7709_PEDR, scan[column].e);
308 		delay(50);
309 		data |= (_reg_read_1(SH7709_PFDR) & 0xfe) |
310 		    (_reg_read_1(SH7709_PCDR) & 0x01);
311 		_reg_write_1(SH7709_PDDR, 0xf7);
312 		_reg_write_1(SH7709_PEDR, 0xff);
313 
314 		pfckbd_input(pc->pc_hpckbd, pc->pc_column, data, column);
315 	}
316 
317 	_reg_write_1(SH7709_PDDR, 0xf7);
318 	_reg_write_1(SH7709_PEDR, 0xff);
319 	data = _reg_read_1(SH7709_PGDR) | (_reg_read_1(SH7709_PHDR) << 8);
320 
321  reinstall:
322 	callout_reset(&pc->pc_soft_ch, 1, pfckbd_callout_hitachi, pc);
323 }
324