pfckbd.c revision 1.19 1 /* $NetBSD: pfckbd.c,v 1.19 2006/02/23 00:46:31 uwe 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.19 2006/02/23 00:46:31 uwe 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 int pfckbd_match(struct device *, struct cfdata *, void *);
70 static void pfckbd_attach(struct device *, struct device *, void *);
71 static void (*pfckbd_callout_lookup(void))(void *);
72 static void pfckbd_callout_unknown(void *);
73 static void pfckbd_callout_hp(void *);
74 static void pfckbd_callout_hitachi(void *);
75
76 static struct pfckbd_core {
77 int pc_attached;
78 int pc_enabled;
79 struct callout pc_soft_ch;
80 struct hpckbd_ic_if pc_if;
81 struct hpckbd_if *pc_hpckbd;
82 uint16_t pc_column[8];
83 void (*pc_callout)(void *);
84 } pfckbd_core;
85
86 /* callout function table. this function is platfrom specific. */
87 static const struct {
88 platid_mask_t *platform;
89 void (*func)(void *);
90 } pfckbd_calloutfunc_table[] = {
91 { &platid_mask_MACH_HP , pfckbd_callout_hp },
92 { &platid_mask_MACH_HITACHI , pfckbd_callout_hitachi }
93 };
94
95 CFATTACH_DECL(pfckbd, sizeof(struct device),
96 pfckbd_match, pfckbd_attach, NULL, NULL);
97
98 static int pfckbd_poll(void *);
99 static void pfckbd_ifsetup(struct pfckbd_core *);
100 static int pfckbd_input_establish(void *, struct hpckbd_if *);
101 static void pfckbd_input(struct hpckbd_if *, uint16_t *, uint16_t, int);
102
103 void
104 pfckbd_cnattach()
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 console */
116 hpckbd_cnattach(&pc->pc_if);
117 }
118
119 static int
120 pfckbd_match(struct device *parent, struct cfdata *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);
128 }
129
130 static void
131 pfckbd_attach(struct device *parent, struct device *self, void *aux)
132 {
133 struct hpckbd_attach_args haa;
134
135 printf("\n");
136
137 /* pfckbd is singleton. no more attach */
138 pfckbd_core.pc_attached = 1;
139 pfckbd_ifsetup(&pfckbd_core);
140
141 /* attach hpckbd */
142 haa.haa_ic = &pfckbd_core.pc_if; /* tell the hpckbd to my interface */
143 config_found(self, &haa, hpckbd_print);
144
145 /* install callout handler */
146 callout_init(&pfckbd_core.pc_soft_ch);
147 callout_reset(&pfckbd_core.pc_soft_ch, 1, pfckbd_core.pc_callout,
148 &pfckbd_core);
149 }
150
151 static int
152 pfckbd_input_establish(void *ic, struct hpckbd_if *kbdif)
153 {
154 struct pfckbd_core *pc = ic;
155
156 /* save hpckbd interface */
157 pc->pc_hpckbd = kbdif;
158 /* ok to transact hpckbd */
159 pc->pc_enabled = 1;
160
161 return 0;
162 }
163
164 static int
165 pfckbd_poll(void *arg)
166 {
167 struct pfckbd_core *pc = arg;
168
169 if (pc->pc_enabled)
170 (*pc->pc_callout)(arg);
171
172 return 0;
173 }
174
175 static void
176 pfckbd_ifsetup(struct pfckbd_core *pc)
177 {
178 int i;
179
180 pc->pc_if.hii_ctx = pc;
181 pc->pc_if.hii_establish = pfckbd_input_establish;
182 pc->pc_if.hii_poll = pfckbd_poll;
183 for (i = 0; i < 8; i++)
184 pc->pc_column[i] = 0xdfff;
185
186 /* select PFC access method */
187 pc->pc_callout = pfckbd_callout_lookup();
188 }
189
190 static void
191 pfckbd_input(struct hpckbd_if *hpckbd, uint16_t *buf, uint16_t data,
192 int column)
193 {
194 int row, type, val;
195 unsigned int edge, mask;
196
197 edge = data ^ buf[column];
198 if (edge) {
199 buf[column] = data;
200
201 for (row = 0, mask = 1; row < 16; row++, mask <<= 1) {
202 if (mask & edge) {
203 type = mask & data ? 0 : 1;
204 val = row * 8 + column;
205 DPRINTF("(%2d, %2d) %d \n",
206 row, column, type);
207 hpckbd_input(hpckbd, type, val);
208 }
209 }
210 }
211 }
212
213 /*
214 * Platform dependent routines.
215 */
216
217 /* Look up appropriate callback handler */
218 static void
219 (*pfckbd_callout_lookup())(void *)
220 {
221 int i, n = sizeof(pfckbd_calloutfunc_table) /
222 sizeof(pfckbd_calloutfunc_table[0]);
223
224 for (i = 0; i < n; i++)
225 if (platid_match(&platid,
226 pfckbd_calloutfunc_table[i].platform))
227 return (pfckbd_calloutfunc_table[i].func);
228
229 return (pfckbd_callout_unknown);
230 }
231
232 /* Placeholder for unknown platform */
233 static void
234 pfckbd_callout_unknown(void *arg)
235 {
236
237 printf("%s: unknown keyboard switch\n", __func__);
238 }
239
240 /* HP Jornada680/690, HP620LX */
241 static void
242 pfckbd_callout_hp(void *arg)
243 {
244 #define PFCKBD_HP_PDCR_MASK 0xcc0c
245 #define PFCKBD_HP_PECR_MASK 0xf0cf
246
247 /*
248 * Disable output on all lines but the n'th line in D.
249 * Pull the n'th scan line in D low.
250 */
251 #define PD(n) \
252 { (uint16_t)(PFCKBD_HP_PDCR_MASK & (~(1 << (2*(n)+1)))), \
253 (uint16_t)(PFCKBD_HP_PECR_MASK & 0xffff), \
254 (uint8_t)~(1 << (n)), \
255 0xff }
256
257 /* Ditto for E */
258 #define PE(n) \
259 { (uint16_t)(PFCKBD_HP_PDCR_MASK & 0xffff), \
260 (uint16_t)(PFCKBD_HP_PECR_MASK & (~(1 << (2*(n)+1)))), \
261 0xff, \
262 (uint8_t)~(1 << (n)) }
263
264 static const struct {
265 uint16_t dc, ec; uint8_t d, e;
266 } scan[] = {
267 PD(1), PD(5), PE(1), PE(6), PE(7), PE(3), PE(0), PD(7)
268 };
269
270 #undef PD
271 #undef PE
272
273 struct pfckbd_core *pc = arg;
274 uint16_t dc, ec;
275 int column;
276 uint16_t data;
277
278 if (!pc->pc_enabled)
279 goto reinstall;
280
281 /* bits in D/E control regs we do not touch (XXX: can they change?) */
282 dc = _reg_read_2(SH7709_PDCR) & ~PFCKBD_HP_PDCR_MASK;
283 ec = _reg_read_2(SH7709_PECR) & ~PFCKBD_HP_PECR_MASK;
284
285 for (column = 0; column < 8; column++) {
286 /* disable output to all lines except the one we scan */
287 _reg_write_2(SH7709_PDCR, dc | scan[column].dc);
288 _reg_write_2(SH7709_PECR, ec | scan[column].ec);
289 delay(5);
290
291 /* pull the scan line low */
292 _reg_write_1(SH7709_PDDR, scan[column].d);
293 _reg_write_1(SH7709_PEDR, scan[column].e);
294 delay(50);
295
296 /* read sense */
297 data = _reg_read_1(SH7709_PFDR) |
298 (_reg_read_1(SH7709_PCDR) << 8);
299
300 pfckbd_input(pc->pc_hpckbd, pc->pc_column, data, column);
301 }
302
303 /* scan no lines */
304 _reg_write_1(SH7709_PDDR, 0xff);
305 _reg_write_1(SH7709_PEDR, 0xff);
306
307 /* enable all scan lines */
308 _reg_write_2(SH7709_PDCR, dc | (0x5555 & PFCKBD_HP_PDCR_MASK));
309 _reg_write_2(SH7709_PECR, ec | (0x5555 & PFCKBD_HP_PECR_MASK));
310
311 #if 0
312 /* (ignore) extra keys/events (recorder buttons, lid, cable &c) */
313 data = _reg_read_1(SH7709_PGDR) | (_reg_read_1(SH7709_PHDR) << 8);
314 #endif
315
316 reinstall:
317 callout_schedule(&pc->pc_soft_ch, 1);
318 }
319
320 /* HITACH PERSONA (HPW-50PAD) */
321 static void
322 pfckbd_callout_hitachi(void *arg)
323 {
324 #define PFCKBD_HITACHI_PCCR_MASK 0xfff3
325 #define PFCKBD_HITACHI_PDCR_MASK 0x000c
326 #define PFCKBD_HITACHI_PECR_MASK 0x30cf
327
328 #define PFCKBD_HITACHI_PCDR_SCN_MASK 0xfd
329 #define PFCKBD_HITACHI_PDDR_SCN_MASK 0xf7
330 #define PFCKBD_HITACHI_PEDR_SCN_MASK 0xff
331
332 #define PFCKBD_HITACHI_PCDR_SNS_MASK 0x01
333 #define PFCKBD_HITACHI_PFDR_SNS_MASK 0xfe
334
335 /*
336 * Disable output on all lines but the n'th line in C.
337 * Pull the n'th scan line in C low.
338 */
339 #define PC(n) \
340 { (uint16_t)(PFCKBD_HITACHI_PCCR_MASK & (~(1 << (2*(n)+1)))), \
341 (uint16_t)(PFCKBD_HITACHI_PDCR_MASK & 0xffff), \
342 (uint16_t)(PFCKBD_HITACHI_PECR_MASK & 0xffff), \
343 (uint8_t)(PFCKBD_HITACHI_PCDR_SCN_MASK & ~(1 << (n))), \
344 PFCKBD_HITACHI_PDDR_SCN_MASK, \
345 PFCKBD_HITACHI_PEDR_SCN_MASK }
346
347 /* Ditto for D */
348 #define PD(n) \
349 { (uint16_t)(PFCKBD_HITACHI_PCCR_MASK & 0xffff), \
350 (uint16_t)(PFCKBD_HITACHI_PDCR_MASK & (~(1 << (2*(n)+1)))), \
351 (uint16_t)(PFCKBD_HITACHI_PECR_MASK & 0xffff), \
352 PFCKBD_HITACHI_PCDR_SCN_MASK, \
353 (uint8_t)(PFCKBD_HITACHI_PDDR_SCN_MASK & ~(1 << (n))), \
354 PFCKBD_HITACHI_PEDR_SCN_MASK }
355
356 /* Ditto for E */
357 #define PE(n) \
358 { (uint16_t)(PFCKBD_HITACHI_PCCR_MASK & 0xffff), \
359 (uint16_t)(PFCKBD_HITACHI_PDCR_MASK & 0xffff), \
360 (uint16_t)(PFCKBD_HITACHI_PECR_MASK & (~(1 << (2*(n)+1)))), \
361 PFCKBD_HITACHI_PCDR_SCN_MASK, \
362 PFCKBD_HITACHI_PDDR_SCN_MASK, \
363 (uint8_t)(PFCKBD_HITACHI_PEDR_SCN_MASK & ~(1 << (n))) }
364
365 static const struct {
366 uint16_t cc, dc, ec; uint8_t c, d, e;
367 } scan[] = {
368 PE(6), PE(3), PE(1), PE(0), PC(7), PC(6), PC(5), PC(4),
369 PC(3), PC(2), PD(1), PC(0)
370 };
371
372 #undef PC
373 #undef PD
374 #undef PE
375
376 struct pfckbd_core *pc = arg;
377 uint16_t cc, dc, ec;
378 uint8_t data[2], cd, dd, ed;
379 int i;
380
381 if (!pc->pc_enabled)
382 goto reinstall;
383
384 /* bits in C/D/E control regs we do not touch (XXX: can they change?) */
385 cc = _reg_read_2(SH7709_PCCR) & ~PFCKBD_HITACHI_PCCR_MASK;
386 dc = _reg_read_2(SH7709_PDCR) & ~PFCKBD_HITACHI_PDCR_MASK;
387 ec = _reg_read_2(SH7709_PECR) & ~PFCKBD_HITACHI_PECR_MASK;
388
389 cd = _reg_read_1(SH7709_PCDR);
390 dd = _reg_read_1(SH7709_PDDR);
391 ed = _reg_read_1(SH7709_PEDR);
392
393 for (i = 0; i < 12; i++) {
394 /* disable output to all lines except the one we scan */
395 _reg_write_2(SH7709_PCCR, cc | scan[i].cc);
396 _reg_write_2(SH7709_PDCR, dc | scan[i].dc);
397 _reg_write_2(SH7709_PECR, ec | scan[i].ec);
398 delay(5);
399
400 /* pull the scan line low */
401 _reg_write_1(SH7709_PCDR, scan[i].c);
402 _reg_write_1(SH7709_PDDR, scan[i].d);
403 _reg_write_1(SH7709_PEDR, scan[i].e);
404 delay(50);
405
406 /* read sense */
407 data[i & 0x1] =
408 ((_reg_read_1(SH7709_PCDR) & PFCKBD_HITACHI_PCDR_SNS_MASK) |
409 (_reg_read_1(SH7709_PFDR) & PFCKBD_HITACHI_PFDR_SNS_MASK));
410
411 if (i & 0x1)
412 pfckbd_input(pc->pc_hpckbd, pc->pc_column,
413 (data[0] | (data[1] << 8)), (i >> 1));
414 }
415
416 /* scan no lines */
417 _reg_write_1(SH7709_PCDR, cd);
418 _reg_write_1(SH7709_PDDR, dd);
419 _reg_write_1(SH7709_PEDR, ed);
420
421 /* enable all scan lines */
422 _reg_write_2(SH7709_PCCR, cc | (0x5555 & PFCKBD_HITACHI_PCCR_MASK));
423 _reg_write_2(SH7709_PDCR, dc | (0x5555 & PFCKBD_HITACHI_PDCR_MASK));
424 _reg_write_2(SH7709_PECR, ec | (0x5555 & PFCKBD_HITACHI_PECR_MASK));
425
426 reinstall:
427 callout_schedule(&pc->pc_soft_ch, 1);
428 }
429