pfckbd.c revision 1.21.8.1 1 /* $NetBSD: pfckbd.c,v 1.21.8.1 2007/10/02 18:27:02 joerg 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.21.8.1 2007/10/02 18:27:02 joerg 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(struct device *, struct cfdata *, void *);
80 static void pfckbd_attach(struct device *, struct device *, void *);
81
82 CFATTACH_DECL(pfckbd, sizeof(struct device),
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(struct device *parent, struct cfdata *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(struct device *parent, struct device *self, void *aux)
139 {
140 struct hpckbd_attach_args haa;
141
142 printf("\n");
143
144 pfckbd_core.pc_attached = 1;
145
146 pfckbd_ifsetup(&pfckbd_core);
147
148 /* attach hpckbd */
149 haa.haa_ic = &pfckbd_core.pc_if; /* tell hpckbd our interface */
150 config_found(self, &haa, hpckbd_print);
151
152 /* install callout handler */
153 callout_init(&pfckbd_core.pc_soft_ch, 0);
154 callout_reset(&pfckbd_core.pc_soft_ch, 1,
155 pfckbd_core.pc_callout, &pfckbd_core);
156 }
157
158 static void
159 pfckbd_ifsetup(struct pfckbd_core *pc)
160 {
161 int i;
162
163 pc->pc_if.hii_ctx = pc;
164 pc->pc_if.hii_establish = pfckbd_input_establish;
165 pc->pc_if.hii_poll = pfckbd_poll;
166
167 for (i = 0; i < 8; i++)
168 pc->pc_column[i] = 0xdfff;
169
170 /* select PFC access method */
171 pc->pc_callout = pfckbd_callout_lookup();
172 }
173
174
175 /*
176 * Callback for hpckbd_initif
177 */
178 static int
179 pfckbd_input_establish(void *ic, struct hpckbd_if *kbdif)
180 {
181 struct pfckbd_core *pc = ic;
182
183 pc->pc_hpckbd = kbdif; /* save hpckbd interface */
184 pc->pc_enabled = 1; /* ok to talk to hpckbd */
185
186 return 0;
187 }
188
189 /*
190 * Callback for hpckbd_cngetc
191 */
192 static int
193 pfckbd_poll(void *ic)
194 {
195 struct pfckbd_core *pc = ic;
196
197 if (pc->pc_enabled)
198 (*pc->pc_callout)(pc);
199
200 return 0;
201 }
202
203 /*
204 * Called by platform specific scan routines to report key events to hpckbd
205 */
206 static void
207 pfckbd_input(struct pfckbd_core *pc, int column, uint16_t data)
208 {
209 int row, type, val;
210 unsigned int edge, mask;
211
212 edge = data ^ pc->pc_column[column];
213 if (edge == 0)
214 return; /* no changes in this column */
215
216 pc->pc_column[column] = data;
217
218 for (row = 0, mask = 1; row < 16; ++row, mask <<= 1) {
219 if (mask & edge) {
220 type = mask & data ? /* up */ 0 : /* down */ 1;
221 DPRINTF("(%2d, %2d) %d \n", row, column, type);
222
223 val = row * 8 + column;
224 hpckbd_input(pc->pc_hpckbd, type, val);
225 }
226 }
227 }
228
229
230 /*
231 * Platform dependent scan routines.
232 */
233
234 /* Look up appropriate callback handler */
235 static void
236 (*pfckbd_callout_lookup())(void *)
237 {
238 int i, n;
239
240 n = sizeof(pfckbd_calloutfunc_table)
241 / sizeof(pfckbd_calloutfunc_table[0]);
242
243 for (i = 0; i < n; i++)
244 if (platid_match(&platid,
245 pfckbd_calloutfunc_table[i].platform))
246 return pfckbd_calloutfunc_table[i].func;
247
248 return pfckbd_callout_unknown;
249 }
250
251 /* Placeholder for unknown platform */
252 static void
253 pfckbd_callout_unknown(void *arg)
254 {
255
256 printf("%s: unknown keyboard switch\n", __func__);
257 }
258
259 /*
260 * HP Jornada680/690, HP620LX
261 */
262 static void
263 pfckbd_callout_hp(void *arg)
264 {
265 #define PFCKBD_HP_PDCR_MASK 0xcc0c
266 #define PFCKBD_HP_PECR_MASK 0xf0cf
267
268 /*
269 * Disable output on all lines but the n'th line in D.
270 * Pull the n'th scan line in D low.
271 */
272 #define PD(n) \
273 { (uint16_t)(PFCKBD_HP_PDCR_MASK & (~(1 << (2*(n)+1)))), \
274 (uint16_t)(PFCKBD_HP_PECR_MASK & 0xffff), \
275 (uint8_t)~(1 << (n)), \
276 0xff }
277
278 /* Ditto for E */
279 #define PE(n) \
280 { (uint16_t)(PFCKBD_HP_PDCR_MASK & 0xffff), \
281 (uint16_t)(PFCKBD_HP_PECR_MASK & (~(1 << (2*(n)+1)))), \
282 0xff, \
283 (uint8_t)~(1 << (n)) }
284
285 static const struct {
286 uint16_t dc, ec; uint8_t d, e;
287 } scan[] = {
288 PD(1), PD(5), PE(1), PE(6), PE(7), PE(3), PE(0), PD(7)
289 };
290
291 #undef PD
292 #undef PE
293
294 struct pfckbd_core *pc = arg;
295 uint16_t dc, ec;
296 int column;
297 uint16_t data;
298
299 if (!pc->pc_enabled)
300 goto reinstall;
301
302 /* bits in D/E control regs we do not touch (XXX: can they change?) */
303 dc = _reg_read_2(SH7709_PDCR) & ~PFCKBD_HP_PDCR_MASK;
304 ec = _reg_read_2(SH7709_PECR) & ~PFCKBD_HP_PECR_MASK;
305
306 for (column = 0; column < 8; column++) {
307 /* disable output to all lines except the one we scan */
308 _reg_write_2(SH7709_PDCR, dc | scan[column].dc);
309 _reg_write_2(SH7709_PECR, ec | scan[column].ec);
310 delay(5);
311
312 /* pull the scan line low */
313 _reg_write_1(SH7709_PDDR, scan[column].d);
314 _reg_write_1(SH7709_PEDR, scan[column].e);
315 delay(50);
316
317 /* read sense */
318 data = _reg_read_1(SH7709_PFDR)
319 | (_reg_read_1(SH7709_PCDR) << 8);
320
321 pfckbd_input(pc, column, data);
322 }
323
324 /* scan no lines */
325 _reg_write_1(SH7709_PDDR, 0xff);
326 _reg_write_1(SH7709_PEDR, 0xff);
327
328 /* enable all scan lines */
329 _reg_write_2(SH7709_PDCR, dc | (0x5555 & PFCKBD_HP_PDCR_MASK));
330 _reg_write_2(SH7709_PECR, ec | (0x5555 & PFCKBD_HP_PECR_MASK));
331
332 #if 0
333 /* (ignore) extra keys/events (recorder buttons, lid, cable &c) */
334 data = _reg_read_1(SH7709_PGDR) | (_reg_read_1(SH7709_PHDR) << 8);
335 #endif
336
337 reinstall:
338 callout_schedule(&pc->pc_soft_ch, 1);
339 }
340
341 /*
342 * HITACH PERSONA (HPW-50PAD)
343 */
344 static void
345 pfckbd_callout_hitachi(void *arg)
346 {
347 #define PFCKBD_HITACHI_PCCR_MASK 0xfff3
348 #define PFCKBD_HITACHI_PDCR_MASK 0x000c
349 #define PFCKBD_HITACHI_PECR_MASK 0x30cf
350
351 #define PFCKBD_HITACHI_PCDR_SCN_MASK 0xfd
352 #define PFCKBD_HITACHI_PDDR_SCN_MASK 0x02
353 #define PFCKBD_HITACHI_PEDR_SCN_MASK 0x4b
354
355 #define PFCKBD_HITACHI_PCDR_SNS_MASK 0x01
356 #define PFCKBD_HITACHI_PFDR_SNS_MASK 0xfe
357
358 /*
359 * Disable output on all lines but the n'th line in C.
360 * Pull the n'th scan line in C low.
361 */
362 #define PC(n) \
363 { (uint16_t)(PFCKBD_HITACHI_PCCR_MASK & (~(1 << (2*(n)+1)))), \
364 (uint16_t)(PFCKBD_HITACHI_PDCR_MASK & 0xffff), \
365 (uint16_t)(PFCKBD_HITACHI_PECR_MASK & 0xffff), \
366 (uint8_t)(PFCKBD_HITACHI_PCDR_SCN_MASK & ~(1 << (n))), \
367 PFCKBD_HITACHI_PDDR_SCN_MASK, \
368 PFCKBD_HITACHI_PEDR_SCN_MASK }
369
370 /* Ditto for D */
371 #define PD(n) \
372 { (uint16_t)(PFCKBD_HITACHI_PCCR_MASK & 0xffff), \
373 (uint16_t)(PFCKBD_HITACHI_PDCR_MASK & (~(1 << (2*(n)+1)))), \
374 (uint16_t)(PFCKBD_HITACHI_PECR_MASK & 0xffff), \
375 PFCKBD_HITACHI_PCDR_SCN_MASK, \
376 (uint8_t)(PFCKBD_HITACHI_PDDR_SCN_MASK & ~(1 << (n))), \
377 PFCKBD_HITACHI_PEDR_SCN_MASK }
378
379 /* Ditto for E */
380 #define PE(n) \
381 { (uint16_t)(PFCKBD_HITACHI_PCCR_MASK & 0xffff), \
382 (uint16_t)(PFCKBD_HITACHI_PDCR_MASK & 0xffff), \
383 (uint16_t)(PFCKBD_HITACHI_PECR_MASK & (~(1 << (2*(n)+1)))), \
384 PFCKBD_HITACHI_PCDR_SCN_MASK, \
385 PFCKBD_HITACHI_PDDR_SCN_MASK, \
386 (uint8_t)(PFCKBD_HITACHI_PEDR_SCN_MASK & ~(1 << (n))) }
387
388 static const struct {
389 uint16_t cc, dc, ec; uint8_t c, d, e;
390 } scan[] = {
391 PE(6), PE(3), PE(1), PE(0), PC(7), PC(6), PC(5), PC(4),
392 PC(3), PC(2), PD(1), PC(0)
393 };
394
395 struct pfckbd_core *pc = arg;
396 uint16_t cc, dc, ec;
397 uint8_t data[2], cd, dd, ed;
398 int i;
399
400 if (!pc->pc_enabled)
401 goto reinstall;
402
403 /* bits in C/D/E control regs we do not touch (XXX: can they change?) */
404 cc = _reg_read_2(SH7709_PCCR) & ~PFCKBD_HITACHI_PCCR_MASK;
405 dc = _reg_read_2(SH7709_PDCR) & ~PFCKBD_HITACHI_PDCR_MASK;
406 ec = _reg_read_2(SH7709_PECR) & ~PFCKBD_HITACHI_PECR_MASK;
407
408 for (i = 0; i < 12; i++) {
409 /* disable output to all lines except the one we scan */
410 _reg_write_2(SH7709_PCCR, cc | scan[i].cc);
411 _reg_write_2(SH7709_PDCR, dc | scan[i].dc);
412 _reg_write_2(SH7709_PECR, ec | scan[i].ec);
413 delay(5);
414
415 cd = _reg_read_1(SH7709_PCDR) & ~PFCKBD_HITACHI_PCDR_SCN_MASK;
416 dd = _reg_read_1(SH7709_PDDR) & ~PFCKBD_HITACHI_PDDR_SCN_MASK;
417 ed = _reg_read_1(SH7709_PEDR) & ~PFCKBD_HITACHI_PEDR_SCN_MASK;
418
419 /* pull the scan line low */
420 _reg_write_1(SH7709_PCDR, cd | scan[i].c);
421 _reg_write_1(SH7709_PDDR, dd | scan[i].d);
422 _reg_write_1(SH7709_PEDR, ed | scan[i].e);
423 delay(50);
424
425 /* read sense */
426 data[i & 0x1] =
427 (_reg_read_1(SH7709_PCDR) & PFCKBD_HITACHI_PCDR_SNS_MASK)
428 | (_reg_read_1(SH7709_PFDR) & PFCKBD_HITACHI_PFDR_SNS_MASK);
429
430 if (i & 0x1)
431 pfckbd_input(pc, (i >> 1), (data[0] | (data[1] << 8)));
432 }
433
434 /* enable all scan lines */
435 _reg_write_2(SH7709_PCCR, cc | (0x5555 & PFCKBD_HITACHI_PCCR_MASK));
436 _reg_write_2(SH7709_PDCR, dc | (0x5555 & PFCKBD_HITACHI_PDCR_MASK));
437 _reg_write_2(SH7709_PECR, ec | (0x5555 & PFCKBD_HITACHI_PECR_MASK));
438
439 reinstall:
440 callout_schedule(&pc->pc_soft_ch, 1);
441 }
442
443 void
444 pfckbd_poll_hitachi_power()
445 {
446 static const struct {
447 uint16_t cc, dc, ec; uint8_t c, d, e;
448 } poll = PD(1);
449
450 #undef PC
451 #undef PD
452 #undef PE
453
454 uint16_t cc, dc, ec;
455 uint8_t cd, dd, ed;
456
457 /* bits in C/D/E control regs we do not touch (XXX: can they change?) */
458 cc = _reg_read_2(SH7709_PCCR) & ~PFCKBD_HITACHI_PCCR_MASK;
459 dc = _reg_read_2(SH7709_PDCR) & ~PFCKBD_HITACHI_PDCR_MASK;
460 ec = _reg_read_2(SH7709_PECR) & ~PFCKBD_HITACHI_PECR_MASK;
461
462 /* disable output to all lines except the one we scan */
463 _reg_write_2(SH7709_PCCR, cc | poll.cc);
464 _reg_write_2(SH7709_PDCR, dc | poll.dc);
465 _reg_write_2(SH7709_PECR, ec | poll.ec);
466 delay(5);
467
468 cd = _reg_read_1(SH7709_PCDR) & ~PFCKBD_HITACHI_PCDR_SCN_MASK;
469 dd = _reg_read_1(SH7709_PDDR) & ~PFCKBD_HITACHI_PDDR_SCN_MASK;
470 ed = _reg_read_1(SH7709_PEDR) & ~PFCKBD_HITACHI_PEDR_SCN_MASK;
471
472 /* pull the scan line low */
473 _reg_write_1(SH7709_PCDR, cd | poll.c);
474 _reg_write_1(SH7709_PDDR, dd | poll.d);
475 _reg_write_1(SH7709_PEDR, ed | poll.e);
476 delay(50);
477
478 /* poll POWER On */
479 while (_reg_read_1(SH7709_PCDR) & PFCKBD_HITACHI_PCDR_SNS_MASK & 0x01);
480
481 /* enable all scan lines */
482 _reg_write_2(SH7709_PCCR, cc | (0x5555 & PFCKBD_HITACHI_PCCR_MASK));
483 _reg_write_2(SH7709_PDCR, dc | (0x5555 & PFCKBD_HITACHI_PDCR_MASK));
484 _reg_write_2(SH7709_PECR, ec | (0x5555 & PFCKBD_HITACHI_PECR_MASK));
485 }
486