tracing: Sanitize value returned from write(trace_marker, "...", len)
[linux-2.6/linux-acpi-2.6/ibm-acpi-2.6.git] / drivers / input / serio / hil_mlc.c
blobc92f4edfee7beef3a326e0af4e43275093fba8dc
1 /*
2 * HIL MLC state machine and serio interface driver
4 * Copyright (c) 2001 Brian S. Julin
5 * All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions, and the following disclaimer,
12 * without modification.
13 * 2. The name of the author may not be used to endorse or promote products
14 * derived from this software without specific prior written permission.
16 * Alternatively, this software may be distributed under the terms of the
17 * GNU General Public License ("GPL").
19 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
23 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 * References:
30 * HP-HIL Technical Reference Manual. Hewlett Packard Product No. 45918A
33 * Driver theory of operation:
35 * Some access methods and an ISR is defined by the sub-driver
36 * (e.g. hp_sdc_mlc.c). These methods are expected to provide a
37 * few bits of logic in addition to raw access to the HIL MLC,
38 * specifically, the ISR, which is entirely registered by the
39 * sub-driver and invoked directly, must check for record
40 * termination or packet match, at which point a semaphore must
41 * be cleared and then the hil_mlcs_tasklet must be scheduled.
43 * The hil_mlcs_tasklet processes the state machine for all MLCs
44 * each time it runs, checking each MLC's progress at the current
45 * node in the state machine, and moving the MLC to subsequent nodes
46 * in the state machine when appropriate. It will reschedule
47 * itself if output is pending. (This rescheduling should be replaced
48 * at some point with a sub-driver-specific mechanism.)
50 * A timer task prods the tasklet once per second to prevent
51 * hangups when attached devices do not return expected data
52 * and to initiate probes of the loop for new devices.
55 #include <linux/hil_mlc.h>
56 #include <linux/errno.h>
57 #include <linux/kernel.h>
58 #include <linux/module.h>
59 #include <linux/init.h>
60 #include <linux/interrupt.h>
61 #include <linux/slab.h>
62 #include <linux/timer.h>
63 #include <linux/list.h>
65 MODULE_AUTHOR("Brian S. Julin <bri@calyx.com>");
66 MODULE_DESCRIPTION("HIL MLC serio");
67 MODULE_LICENSE("Dual BSD/GPL");
69 EXPORT_SYMBOL(hil_mlc_register);
70 EXPORT_SYMBOL(hil_mlc_unregister);
72 #define PREFIX "HIL MLC: "
74 static LIST_HEAD(hil_mlcs);
75 static DEFINE_RWLOCK(hil_mlcs_lock);
76 static struct timer_list hil_mlcs_kicker;
77 static int hil_mlcs_probe;
79 static void hil_mlcs_process(unsigned long unused);
80 static DECLARE_TASKLET_DISABLED(hil_mlcs_tasklet, hil_mlcs_process, 0);
83 /* #define HIL_MLC_DEBUG */
85 /********************** Device info/instance management **********************/
87 static void hil_mlc_clear_di_map(hil_mlc *mlc, int val)
89 int j;
91 for (j = val; j < 7 ; j++)
92 mlc->di_map[j] = -1;
95 static void hil_mlc_clear_di_scratch(hil_mlc *mlc)
97 memset(&mlc->di_scratch, 0, sizeof(mlc->di_scratch));
100 static void hil_mlc_copy_di_scratch(hil_mlc *mlc, int idx)
102 memcpy(&mlc->di[idx], &mlc->di_scratch, sizeof(mlc->di_scratch));
105 static int hil_mlc_match_di_scratch(hil_mlc *mlc)
107 int idx;
109 for (idx = 0; idx < HIL_MLC_DEVMEM; idx++) {
110 int j, found = 0;
112 /* In-use slots are not eligible. */
113 for (j = 0; j < 7 ; j++)
114 if (mlc->di_map[j] == idx)
115 found++;
117 if (found)
118 continue;
120 if (!memcmp(mlc->di + idx, &mlc->di_scratch,
121 sizeof(mlc->di_scratch)))
122 break;
124 return idx >= HIL_MLC_DEVMEM ? -1 : idx;
127 static int hil_mlc_find_free_di(hil_mlc *mlc)
129 int idx;
131 /* TODO: Pick all-zero slots first, failing that,
132 * randomize the slot picked among those eligible.
134 for (idx = 0; idx < HIL_MLC_DEVMEM; idx++) {
135 int j, found = 0;
137 for (j = 0; j < 7 ; j++)
138 if (mlc->di_map[j] == idx)
139 found++;
141 if (!found)
142 break;
145 return idx; /* Note: It is guaranteed at least one above will match */
148 static inline void hil_mlc_clean_serio_map(hil_mlc *mlc)
150 int idx;
152 for (idx = 0; idx < HIL_MLC_DEVMEM; idx++) {
153 int j, found = 0;
155 for (j = 0; j < 7 ; j++)
156 if (mlc->di_map[j] == idx)
157 found++;
159 if (!found)
160 mlc->serio_map[idx].di_revmap = -1;
164 static void hil_mlc_send_polls(hil_mlc *mlc)
166 int did, i, cnt;
167 struct serio *serio;
168 struct serio_driver *drv;
170 i = cnt = 0;
171 did = (mlc->ipacket[0] & HIL_PKT_ADDR_MASK) >> 8;
172 serio = did ? mlc->serio[mlc->di_map[did - 1]] : NULL;
173 drv = (serio != NULL) ? serio->drv : NULL;
175 while (mlc->icount < 15 - i) {
176 hil_packet p;
178 p = mlc->ipacket[i];
179 if (did != (p & HIL_PKT_ADDR_MASK) >> 8) {
180 if (drv && drv->interrupt) {
181 drv->interrupt(serio, 0, 0);
182 drv->interrupt(serio, HIL_ERR_INT >> 16, 0);
183 drv->interrupt(serio, HIL_PKT_CMD >> 8, 0);
184 drv->interrupt(serio, HIL_CMD_POL + cnt, 0);
187 did = (p & HIL_PKT_ADDR_MASK) >> 8;
188 serio = did ? mlc->serio[mlc->di_map[did-1]] : NULL;
189 drv = (serio != NULL) ? serio->drv : NULL;
190 cnt = 0;
193 cnt++;
194 i++;
196 if (drv && drv->interrupt) {
197 drv->interrupt(serio, (p >> 24), 0);
198 drv->interrupt(serio, (p >> 16) & 0xff, 0);
199 drv->interrupt(serio, (p >> 8) & ~HIL_PKT_ADDR_MASK, 0);
200 drv->interrupt(serio, p & 0xff, 0);
205 /*************************** State engine *********************************/
207 #define HILSEN_SCHED 0x000100 /* Schedule the tasklet */
208 #define HILSEN_BREAK 0x000200 /* Wait until next pass */
209 #define HILSEN_UP 0x000400 /* relative node#, decrement */
210 #define HILSEN_DOWN 0x000800 /* relative node#, increment */
211 #define HILSEN_FOLLOW 0x001000 /* use retval as next node# */
213 #define HILSEN_MASK 0x0000ff
214 #define HILSEN_START 0
215 #define HILSEN_RESTART 1
216 #define HILSEN_DHR 9
217 #define HILSEN_DHR2 10
218 #define HILSEN_IFC 14
219 #define HILSEN_HEAL0 16
220 #define HILSEN_HEAL 18
221 #define HILSEN_ACF 21
222 #define HILSEN_ACF2 22
223 #define HILSEN_DISC0 25
224 #define HILSEN_DISC 27
225 #define HILSEN_MATCH 40
226 #define HILSEN_OPERATE 41
227 #define HILSEN_PROBE 44
228 #define HILSEN_DSR 52
229 #define HILSEN_REPOLL 55
230 #define HILSEN_IFCACF 58
231 #define HILSEN_END 60
233 #define HILSEN_NEXT (HILSEN_DOWN | 1)
234 #define HILSEN_SAME (HILSEN_DOWN | 0)
235 #define HILSEN_LAST (HILSEN_UP | 1)
237 #define HILSEN_DOZE (HILSEN_SAME | HILSEN_SCHED | HILSEN_BREAK)
238 #define HILSEN_SLEEP (HILSEN_SAME | HILSEN_BREAK)
240 static int hilse_match(hil_mlc *mlc, int unused)
242 int rc;
244 rc = hil_mlc_match_di_scratch(mlc);
245 if (rc == -1) {
246 rc = hil_mlc_find_free_di(mlc);
247 if (rc == -1)
248 goto err;
250 #ifdef HIL_MLC_DEBUG
251 printk(KERN_DEBUG PREFIX "new in slot %i\n", rc);
252 #endif
253 hil_mlc_copy_di_scratch(mlc, rc);
254 mlc->di_map[mlc->ddi] = rc;
255 mlc->serio_map[rc].di_revmap = mlc->ddi;
256 hil_mlc_clean_serio_map(mlc);
257 serio_rescan(mlc->serio[rc]);
258 return -1;
261 mlc->di_map[mlc->ddi] = rc;
262 #ifdef HIL_MLC_DEBUG
263 printk(KERN_DEBUG PREFIX "same in slot %i\n", rc);
264 #endif
265 mlc->serio_map[rc].di_revmap = mlc->ddi;
266 hil_mlc_clean_serio_map(mlc);
267 return 0;
269 err:
270 printk(KERN_ERR PREFIX "Residual device slots exhausted, close some serios!\n");
271 return 1;
274 /* An LCV used to prevent runaway loops, forces 5 second sleep when reset. */
275 static int hilse_init_lcv(hil_mlc *mlc, int unused)
277 struct timeval tv;
279 do_gettimeofday(&tv);
281 if (mlc->lcv && (tv.tv_sec - mlc->lcv_tv.tv_sec) < 5)
282 return -1;
284 mlc->lcv_tv = tv;
285 mlc->lcv = 0;
287 return 0;
290 static int hilse_inc_lcv(hil_mlc *mlc, int lim)
292 return mlc->lcv++ >= lim ? -1 : 0;
295 #if 0
296 static int hilse_set_lcv(hil_mlc *mlc, int val)
298 mlc->lcv = val;
300 return 0;
302 #endif
304 /* Management of the discovered device index (zero based, -1 means no devs) */
305 static int hilse_set_ddi(hil_mlc *mlc, int val)
307 mlc->ddi = val;
308 hil_mlc_clear_di_map(mlc, val + 1);
310 return 0;
313 static int hilse_dec_ddi(hil_mlc *mlc, int unused)
315 mlc->ddi--;
316 if (mlc->ddi <= -1) {
317 mlc->ddi = -1;
318 hil_mlc_clear_di_map(mlc, 0);
319 return -1;
321 hil_mlc_clear_di_map(mlc, mlc->ddi + 1);
323 return 0;
326 static int hilse_inc_ddi(hil_mlc *mlc, int unused)
328 BUG_ON(mlc->ddi >= 6);
329 mlc->ddi++;
331 return 0;
334 static int hilse_take_idd(hil_mlc *mlc, int unused)
336 int i;
338 /* Help the state engine:
339 * Is this a real IDD response or just an echo?
341 * Real IDD response does not start with a command.
343 if (mlc->ipacket[0] & HIL_PKT_CMD)
344 goto bail;
346 /* Should have the command echoed further down. */
347 for (i = 1; i < 16; i++) {
348 if (((mlc->ipacket[i] & HIL_PKT_ADDR_MASK) ==
349 (mlc->ipacket[0] & HIL_PKT_ADDR_MASK)) &&
350 (mlc->ipacket[i] & HIL_PKT_CMD) &&
351 ((mlc->ipacket[i] & HIL_PKT_DATA_MASK) == HIL_CMD_IDD))
352 break;
354 if (i > 15)
355 goto bail;
357 /* And the rest of the packets should still be clear. */
358 while (++i < 16)
359 if (mlc->ipacket[i])
360 break;
362 if (i < 16)
363 goto bail;
365 for (i = 0; i < 16; i++)
366 mlc->di_scratch.idd[i] =
367 mlc->ipacket[i] & HIL_PKT_DATA_MASK;
369 /* Next step is to see if RSC supported */
370 if (mlc->di_scratch.idd[1] & HIL_IDD_HEADER_RSC)
371 return HILSEN_NEXT;
373 if (mlc->di_scratch.idd[1] & HIL_IDD_HEADER_EXD)
374 return HILSEN_DOWN | 4;
376 return 0;
378 bail:
379 mlc->ddi--;
381 return -1; /* This should send us off to ACF */
384 static int hilse_take_rsc(hil_mlc *mlc, int unused)
386 int i;
388 for (i = 0; i < 16; i++)
389 mlc->di_scratch.rsc[i] =
390 mlc->ipacket[i] & HIL_PKT_DATA_MASK;
392 /* Next step is to see if EXD supported (IDD has already been read) */
393 if (mlc->di_scratch.idd[1] & HIL_IDD_HEADER_EXD)
394 return HILSEN_NEXT;
396 return 0;
399 static int hilse_take_exd(hil_mlc *mlc, int unused)
401 int i;
403 for (i = 0; i < 16; i++)
404 mlc->di_scratch.exd[i] =
405 mlc->ipacket[i] & HIL_PKT_DATA_MASK;
407 /* Next step is to see if RNM supported. */
408 if (mlc->di_scratch.exd[0] & HIL_EXD_HEADER_RNM)
409 return HILSEN_NEXT;
411 return 0;
414 static int hilse_take_rnm(hil_mlc *mlc, int unused)
416 int i;
418 for (i = 0; i < 16; i++)
419 mlc->di_scratch.rnm[i] =
420 mlc->ipacket[i] & HIL_PKT_DATA_MASK;
422 printk(KERN_INFO PREFIX "Device name gotten: %16s\n",
423 mlc->di_scratch.rnm);
425 return 0;
428 static int hilse_operate(hil_mlc *mlc, int repoll)
431 if (mlc->opercnt == 0)
432 hil_mlcs_probe = 0;
433 mlc->opercnt = 1;
435 hil_mlc_send_polls(mlc);
437 if (!hil_mlcs_probe)
438 return 0;
439 hil_mlcs_probe = 0;
440 mlc->opercnt = 0;
441 return 1;
444 #define FUNC(funct, funct_arg, zero_rc, neg_rc, pos_rc) \
445 { HILSE_FUNC, { .func = funct }, funct_arg, zero_rc, neg_rc, pos_rc },
446 #define OUT(pack) \
447 { HILSE_OUT, { .packet = pack }, 0, HILSEN_NEXT, HILSEN_DOZE, 0 },
448 #define CTS \
449 { HILSE_CTS, { .packet = 0 }, 0, HILSEN_NEXT | HILSEN_SCHED | HILSEN_BREAK, HILSEN_DOZE, 0 },
450 #define EXPECT(comp, to, got, got_wrong, timed_out) \
451 { HILSE_EXPECT, { .packet = comp }, to, got, got_wrong, timed_out },
452 #define EXPECT_LAST(comp, to, got, got_wrong, timed_out) \
453 { HILSE_EXPECT_LAST, { .packet = comp }, to, got, got_wrong, timed_out },
454 #define EXPECT_DISC(comp, to, got, got_wrong, timed_out) \
455 { HILSE_EXPECT_DISC, { .packet = comp }, to, got, got_wrong, timed_out },
456 #define IN(to, got, got_error, timed_out) \
457 { HILSE_IN, { .packet = 0 }, to, got, got_error, timed_out },
458 #define OUT_DISC(pack) \
459 { HILSE_OUT_DISC, { .packet = pack }, 0, 0, 0, 0 },
460 #define OUT_LAST(pack) \
461 { HILSE_OUT_LAST, { .packet = pack }, 0, 0, 0, 0 },
463 static const struct hilse_node hil_mlc_se[HILSEN_END] = {
465 /* 0 HILSEN_START */
466 FUNC(hilse_init_lcv, 0, HILSEN_NEXT, HILSEN_SLEEP, 0)
468 /* 1 HILSEN_RESTART */
469 FUNC(hilse_inc_lcv, 10, HILSEN_NEXT, HILSEN_START, 0)
470 OUT(HIL_CTRL_ONLY) /* Disable APE */
473 #define TEST_PACKET(x) \
474 (HIL_PKT_CMD | (x << HIL_PKT_ADDR_SHIFT) | x << 4 | x)
476 OUT(HIL_DO_ALTER_CTRL | HIL_CTRL_TEST | TEST_PACKET(0x5))
477 EXPECT(HIL_ERR_INT | TEST_PACKET(0x5),
478 2000, HILSEN_NEXT, HILSEN_RESTART, HILSEN_RESTART)
479 OUT(HIL_DO_ALTER_CTRL | HIL_CTRL_TEST | TEST_PACKET(0xa))
480 EXPECT(HIL_ERR_INT | TEST_PACKET(0xa),
481 2000, HILSEN_NEXT, HILSEN_RESTART, HILSEN_RESTART)
482 OUT(HIL_CTRL_ONLY | 0) /* Disable test mode */
484 /* 9 HILSEN_DHR */
485 FUNC(hilse_init_lcv, 0, HILSEN_NEXT, HILSEN_SLEEP, 0)
487 /* 10 HILSEN_DHR2 */
488 FUNC(hilse_inc_lcv, 10, HILSEN_NEXT, HILSEN_START, 0)
489 FUNC(hilse_set_ddi, -1, HILSEN_NEXT, 0, 0)
490 OUT(HIL_PKT_CMD | HIL_CMD_DHR)
491 IN(300000, HILSEN_DHR2, HILSEN_DHR2, HILSEN_NEXT)
493 /* 14 HILSEN_IFC */
494 OUT(HIL_PKT_CMD | HIL_CMD_IFC)
495 EXPECT(HIL_PKT_CMD | HIL_CMD_IFC | HIL_ERR_INT,
496 20000, HILSEN_DISC, HILSEN_DHR2, HILSEN_NEXT )
498 /* If devices are there, they weren't in PUP or other loopback mode.
499 * We're more concerned at this point with restoring operation
500 * to devices than discovering new ones, so we try to salvage
501 * the loop configuration by closing off the loop.
504 /* 16 HILSEN_HEAL0 */
505 FUNC(hilse_dec_ddi, 0, HILSEN_NEXT, HILSEN_ACF, 0)
506 FUNC(hilse_inc_ddi, 0, HILSEN_NEXT, 0, 0)
508 /* 18 HILSEN_HEAL */
509 OUT_LAST(HIL_CMD_ELB)
510 EXPECT_LAST(HIL_CMD_ELB | HIL_ERR_INT,
511 20000, HILSEN_REPOLL, HILSEN_DSR, HILSEN_NEXT)
512 FUNC(hilse_dec_ddi, 0, HILSEN_HEAL, HILSEN_NEXT, 0)
514 /* 21 HILSEN_ACF */
515 FUNC(hilse_init_lcv, 0, HILSEN_NEXT, HILSEN_DOZE, 0)
517 /* 22 HILSEN_ACF2 */
518 FUNC(hilse_inc_lcv, 10, HILSEN_NEXT, HILSEN_START, 0)
519 OUT(HIL_PKT_CMD | HIL_CMD_ACF | 1)
520 IN(20000, HILSEN_NEXT, HILSEN_DSR, HILSEN_NEXT)
522 /* 25 HILSEN_DISC0 */
523 OUT_DISC(HIL_PKT_CMD | HIL_CMD_ELB)
524 EXPECT_DISC(HIL_PKT_CMD | HIL_CMD_ELB | HIL_ERR_INT,
525 20000, HILSEN_NEXT, HILSEN_DSR, HILSEN_DSR)
527 /* Only enter here if response just received */
528 /* 27 HILSEN_DISC */
529 OUT_DISC(HIL_PKT_CMD | HIL_CMD_IDD)
530 EXPECT_DISC(HIL_PKT_CMD | HIL_CMD_IDD | HIL_ERR_INT,
531 20000, HILSEN_NEXT, HILSEN_DSR, HILSEN_START)
532 FUNC(hilse_inc_ddi, 0, HILSEN_NEXT, HILSEN_START, 0)
533 FUNC(hilse_take_idd, 0, HILSEN_MATCH, HILSEN_IFCACF, HILSEN_FOLLOW)
534 OUT_LAST(HIL_PKT_CMD | HIL_CMD_RSC)
535 EXPECT_LAST(HIL_PKT_CMD | HIL_CMD_RSC | HIL_ERR_INT,
536 30000, HILSEN_NEXT, HILSEN_DSR, HILSEN_DSR)
537 FUNC(hilse_take_rsc, 0, HILSEN_MATCH, 0, HILSEN_FOLLOW)
538 OUT_LAST(HIL_PKT_CMD | HIL_CMD_EXD)
539 EXPECT_LAST(HIL_PKT_CMD | HIL_CMD_EXD | HIL_ERR_INT,
540 30000, HILSEN_NEXT, HILSEN_DSR, HILSEN_DSR)
541 FUNC(hilse_take_exd, 0, HILSEN_MATCH, 0, HILSEN_FOLLOW)
542 OUT_LAST(HIL_PKT_CMD | HIL_CMD_RNM)
543 EXPECT_LAST(HIL_PKT_CMD | HIL_CMD_RNM | HIL_ERR_INT,
544 30000, HILSEN_NEXT, HILSEN_DSR, HILSEN_DSR)
545 FUNC(hilse_take_rnm, 0, HILSEN_MATCH, 0, 0)
547 /* 40 HILSEN_MATCH */
548 FUNC(hilse_match, 0, HILSEN_NEXT, HILSEN_NEXT, /* TODO */ 0)
550 /* 41 HILSEN_OPERATE */
551 OUT(HIL_PKT_CMD | HIL_CMD_POL)
552 EXPECT(HIL_PKT_CMD | HIL_CMD_POL | HIL_ERR_INT,
553 20000, HILSEN_NEXT, HILSEN_DSR, HILSEN_NEXT)
554 FUNC(hilse_operate, 0, HILSEN_OPERATE, HILSEN_IFC, HILSEN_NEXT)
556 /* 44 HILSEN_PROBE */
557 OUT_LAST(HIL_PKT_CMD | HIL_CMD_EPT)
558 IN(10000, HILSEN_DISC, HILSEN_DSR, HILSEN_NEXT)
559 OUT_DISC(HIL_PKT_CMD | HIL_CMD_ELB)
560 IN(10000, HILSEN_DISC, HILSEN_DSR, HILSEN_NEXT)
561 OUT(HIL_PKT_CMD | HIL_CMD_ACF | 1)
562 IN(10000, HILSEN_DISC0, HILSEN_DSR, HILSEN_NEXT)
563 OUT_LAST(HIL_PKT_CMD | HIL_CMD_ELB)
564 IN(10000, HILSEN_OPERATE, HILSEN_DSR, HILSEN_DSR)
566 /* 52 HILSEN_DSR */
567 FUNC(hilse_set_ddi, -1, HILSEN_NEXT, 0, 0)
568 OUT(HIL_PKT_CMD | HIL_CMD_DSR)
569 IN(20000, HILSEN_DHR, HILSEN_DHR, HILSEN_IFC)
571 /* 55 HILSEN_REPOLL */
572 OUT(HIL_PKT_CMD | HIL_CMD_RPL)
573 EXPECT(HIL_PKT_CMD | HIL_CMD_RPL | HIL_ERR_INT,
574 20000, HILSEN_NEXT, HILSEN_DSR, HILSEN_NEXT)
575 FUNC(hilse_operate, 1, HILSEN_OPERATE, HILSEN_IFC, HILSEN_PROBE)
577 /* 58 HILSEN_IFCACF */
578 OUT(HIL_PKT_CMD | HIL_CMD_IFC)
579 EXPECT(HIL_PKT_CMD | HIL_CMD_IFC | HIL_ERR_INT,
580 20000, HILSEN_ACF2, HILSEN_DHR2, HILSEN_HEAL)
582 /* 60 HILSEN_END */
585 static inline void hilse_setup_input(hil_mlc *mlc, const struct hilse_node *node)
588 switch (node->act) {
589 case HILSE_EXPECT_DISC:
590 mlc->imatch = node->object.packet;
591 mlc->imatch |= ((mlc->ddi + 2) << HIL_PKT_ADDR_SHIFT);
592 break;
593 case HILSE_EXPECT_LAST:
594 mlc->imatch = node->object.packet;
595 mlc->imatch |= ((mlc->ddi + 1) << HIL_PKT_ADDR_SHIFT);
596 break;
597 case HILSE_EXPECT:
598 mlc->imatch = node->object.packet;
599 break;
600 case HILSE_IN:
601 mlc->imatch = 0;
602 break;
603 default:
604 BUG();
606 mlc->istarted = 1;
607 mlc->intimeout = node->arg;
608 do_gettimeofday(&(mlc->instart));
609 mlc->icount = 15;
610 memset(mlc->ipacket, 0, 16 * sizeof(hil_packet));
611 BUG_ON(down_trylock(&mlc->isem));
614 #ifdef HIL_MLC_DEBUG
615 static int doze;
616 static int seidx; /* For debug */
617 #endif
619 static int hilse_donode(hil_mlc *mlc)
621 const struct hilse_node *node;
622 int nextidx = 0;
623 int sched_long = 0;
624 unsigned long flags;
626 #ifdef HIL_MLC_DEBUG
627 if (mlc->seidx && mlc->seidx != seidx &&
628 mlc->seidx != 41 && mlc->seidx != 42 && mlc->seidx != 43) {
629 printk(KERN_DEBUG PREFIX "z%i \n {%i}", doze, mlc->seidx);
630 doze = 0;
633 seidx = mlc->seidx;
634 #endif
635 node = hil_mlc_se + mlc->seidx;
637 switch (node->act) {
638 int rc;
639 hil_packet pack;
641 case HILSE_FUNC:
642 BUG_ON(node->object.func == NULL);
643 rc = node->object.func(mlc, node->arg);
644 nextidx = (rc > 0) ? node->ugly :
645 ((rc < 0) ? node->bad : node->good);
646 if (nextidx == HILSEN_FOLLOW)
647 nextidx = rc;
648 break;
650 case HILSE_EXPECT_LAST:
651 case HILSE_EXPECT_DISC:
652 case HILSE_EXPECT:
653 case HILSE_IN:
654 /* Already set up from previous HILSE_OUT_* */
655 write_lock_irqsave(&mlc->lock, flags);
656 rc = mlc->in(mlc, node->arg);
657 if (rc == 2) {
658 nextidx = HILSEN_DOZE;
659 sched_long = 1;
660 write_unlock_irqrestore(&mlc->lock, flags);
661 break;
663 if (rc == 1)
664 nextidx = node->ugly;
665 else if (rc == 0)
666 nextidx = node->good;
667 else
668 nextidx = node->bad;
669 mlc->istarted = 0;
670 write_unlock_irqrestore(&mlc->lock, flags);
671 break;
673 case HILSE_OUT_LAST:
674 write_lock_irqsave(&mlc->lock, flags);
675 pack = node->object.packet;
676 pack |= ((mlc->ddi + 1) << HIL_PKT_ADDR_SHIFT);
677 goto out;
679 case HILSE_OUT_DISC:
680 write_lock_irqsave(&mlc->lock, flags);
681 pack = node->object.packet;
682 pack |= ((mlc->ddi + 2) << HIL_PKT_ADDR_SHIFT);
683 goto out;
685 case HILSE_OUT:
686 write_lock_irqsave(&mlc->lock, flags);
687 pack = node->object.packet;
688 out:
689 if (mlc->istarted)
690 goto out2;
691 /* Prepare to receive input */
692 if ((node + 1)->act & HILSE_IN)
693 hilse_setup_input(mlc, node + 1);
695 out2:
696 write_unlock_irqrestore(&mlc->lock, flags);
698 if (down_trylock(&mlc->osem)) {
699 nextidx = HILSEN_DOZE;
700 break;
702 up(&mlc->osem);
704 write_lock_irqsave(&mlc->lock, flags);
705 if (!mlc->ostarted) {
706 mlc->ostarted = 1;
707 mlc->opacket = pack;
708 mlc->out(mlc);
709 nextidx = HILSEN_DOZE;
710 write_unlock_irqrestore(&mlc->lock, flags);
711 break;
713 mlc->ostarted = 0;
714 do_gettimeofday(&(mlc->instart));
715 write_unlock_irqrestore(&mlc->lock, flags);
716 nextidx = HILSEN_NEXT;
717 break;
719 case HILSE_CTS:
720 write_lock_irqsave(&mlc->lock, flags);
721 nextidx = mlc->cts(mlc) ? node->bad : node->good;
722 write_unlock_irqrestore(&mlc->lock, flags);
723 break;
725 default:
726 BUG();
729 #ifdef HIL_MLC_DEBUG
730 if (nextidx == HILSEN_DOZE)
731 doze++;
732 #endif
734 while (nextidx & HILSEN_SCHED) {
735 struct timeval tv;
737 if (!sched_long)
738 goto sched;
740 do_gettimeofday(&tv);
741 tv.tv_usec += USEC_PER_SEC * (tv.tv_sec - mlc->instart.tv_sec);
742 tv.tv_usec -= mlc->instart.tv_usec;
743 if (tv.tv_usec >= mlc->intimeout) goto sched;
744 tv.tv_usec = (mlc->intimeout - tv.tv_usec) * HZ / USEC_PER_SEC;
745 if (!tv.tv_usec) goto sched;
746 mod_timer(&hil_mlcs_kicker, jiffies + tv.tv_usec);
747 break;
748 sched:
749 tasklet_schedule(&hil_mlcs_tasklet);
750 break;
753 if (nextidx & HILSEN_DOWN)
754 mlc->seidx += nextidx & HILSEN_MASK;
755 else if (nextidx & HILSEN_UP)
756 mlc->seidx -= nextidx & HILSEN_MASK;
757 else
758 mlc->seidx = nextidx & HILSEN_MASK;
760 if (nextidx & HILSEN_BREAK)
761 return 1;
763 return 0;
766 /******************** tasklet context functions **************************/
767 static void hil_mlcs_process(unsigned long unused)
769 struct list_head *tmp;
771 read_lock(&hil_mlcs_lock);
772 list_for_each(tmp, &hil_mlcs) {
773 struct hil_mlc *mlc = list_entry(tmp, hil_mlc, list);
774 while (hilse_donode(mlc) == 0) {
775 #ifdef HIL_MLC_DEBUG
776 if (mlc->seidx != 41 &&
777 mlc->seidx != 42 &&
778 mlc->seidx != 43)
779 printk(KERN_DEBUG PREFIX " + ");
780 #endif
783 read_unlock(&hil_mlcs_lock);
786 /************************* Keepalive timer task *********************/
788 static void hil_mlcs_timer(unsigned long data)
790 hil_mlcs_probe = 1;
791 tasklet_schedule(&hil_mlcs_tasklet);
792 /* Re-insert the periodic task. */
793 if (!timer_pending(&hil_mlcs_kicker))
794 mod_timer(&hil_mlcs_kicker, jiffies + HZ);
797 /******************** user/kernel context functions **********************/
799 static int hil_mlc_serio_write(struct serio *serio, unsigned char c)
801 struct hil_mlc_serio_map *map;
802 struct hil_mlc *mlc;
803 struct serio_driver *drv;
804 uint8_t *idx, *last;
806 map = serio->port_data;
807 BUG_ON(map == NULL);
809 mlc = map->mlc;
810 BUG_ON(mlc == NULL);
812 mlc->serio_opacket[map->didx] |=
813 ((hil_packet)c) << (8 * (3 - mlc->serio_oidx[map->didx]));
815 if (mlc->serio_oidx[map->didx] >= 3) {
816 /* for now only commands */
817 if (!(mlc->serio_opacket[map->didx] & HIL_PKT_CMD))
818 return -EIO;
819 switch (mlc->serio_opacket[map->didx] & HIL_PKT_DATA_MASK) {
820 case HIL_CMD_IDD:
821 idx = mlc->di[map->didx].idd;
822 goto emu;
823 case HIL_CMD_RSC:
824 idx = mlc->di[map->didx].rsc;
825 goto emu;
826 case HIL_CMD_EXD:
827 idx = mlc->di[map->didx].exd;
828 goto emu;
829 case HIL_CMD_RNM:
830 idx = mlc->di[map->didx].rnm;
831 goto emu;
832 default:
833 break;
835 mlc->serio_oidx[map->didx] = 0;
836 mlc->serio_opacket[map->didx] = 0;
839 mlc->serio_oidx[map->didx]++;
840 return -EIO;
841 emu:
842 drv = serio->drv;
843 BUG_ON(drv == NULL);
845 last = idx + 15;
846 while ((last != idx) && (*last == 0))
847 last--;
849 while (idx != last) {
850 drv->interrupt(serio, 0, 0);
851 drv->interrupt(serio, HIL_ERR_INT >> 16, 0);
852 drv->interrupt(serio, 0, 0);
853 drv->interrupt(serio, *idx, 0);
854 idx++;
856 drv->interrupt(serio, 0, 0);
857 drv->interrupt(serio, HIL_ERR_INT >> 16, 0);
858 drv->interrupt(serio, HIL_PKT_CMD >> 8, 0);
859 drv->interrupt(serio, *idx, 0);
861 mlc->serio_oidx[map->didx] = 0;
862 mlc->serio_opacket[map->didx] = 0;
864 return 0;
867 static int hil_mlc_serio_open(struct serio *serio)
869 struct hil_mlc_serio_map *map;
870 struct hil_mlc *mlc;
872 if (serio_get_drvdata(serio) != NULL)
873 return -EBUSY;
875 map = serio->port_data;
876 BUG_ON(map == NULL);
878 mlc = map->mlc;
879 BUG_ON(mlc == NULL);
881 return 0;
884 static void hil_mlc_serio_close(struct serio *serio)
886 struct hil_mlc_serio_map *map;
887 struct hil_mlc *mlc;
889 map = serio->port_data;
890 BUG_ON(map == NULL);
892 mlc = map->mlc;
893 BUG_ON(mlc == NULL);
895 serio_set_drvdata(serio, NULL);
896 serio->drv = NULL;
897 /* TODO wake up interruptable */
900 static const struct serio_device_id hil_mlc_serio_id = {
901 .type = SERIO_HIL_MLC,
902 .proto = SERIO_HIL,
903 .extra = SERIO_ANY,
904 .id = SERIO_ANY,
907 int hil_mlc_register(hil_mlc *mlc)
909 int i;
910 unsigned long flags;
912 BUG_ON(mlc == NULL);
914 mlc->istarted = 0;
915 mlc->ostarted = 0;
917 rwlock_init(&mlc->lock);
918 init_MUTEX(&mlc->osem);
920 init_MUTEX(&mlc->isem);
921 mlc->icount = -1;
922 mlc->imatch = 0;
924 mlc->opercnt = 0;
926 init_MUTEX_LOCKED(&(mlc->csem));
928 hil_mlc_clear_di_scratch(mlc);
929 hil_mlc_clear_di_map(mlc, 0);
930 for (i = 0; i < HIL_MLC_DEVMEM; i++) {
931 struct serio *mlc_serio;
932 hil_mlc_copy_di_scratch(mlc, i);
933 mlc_serio = kzalloc(sizeof(*mlc_serio), GFP_KERNEL);
934 mlc->serio[i] = mlc_serio;
935 snprintf(mlc_serio->name, sizeof(mlc_serio->name)-1, "HIL_SERIO%d", i);
936 snprintf(mlc_serio->phys, sizeof(mlc_serio->phys)-1, "HIL%d", i);
937 mlc_serio->id = hil_mlc_serio_id;
938 mlc_serio->id.id = i; /* HIL port no. */
939 mlc_serio->write = hil_mlc_serio_write;
940 mlc_serio->open = hil_mlc_serio_open;
941 mlc_serio->close = hil_mlc_serio_close;
942 mlc_serio->port_data = &(mlc->serio_map[i]);
943 mlc->serio_map[i].mlc = mlc;
944 mlc->serio_map[i].didx = i;
945 mlc->serio_map[i].di_revmap = -1;
946 mlc->serio_opacket[i] = 0;
947 mlc->serio_oidx[i] = 0;
948 serio_register_port(mlc_serio);
951 mlc->tasklet = &hil_mlcs_tasklet;
953 write_lock_irqsave(&hil_mlcs_lock, flags);
954 list_add_tail(&mlc->list, &hil_mlcs);
955 mlc->seidx = HILSEN_START;
956 write_unlock_irqrestore(&hil_mlcs_lock, flags);
958 tasklet_schedule(&hil_mlcs_tasklet);
959 return 0;
962 int hil_mlc_unregister(hil_mlc *mlc)
964 struct list_head *tmp;
965 unsigned long flags;
966 int i;
968 BUG_ON(mlc == NULL);
970 write_lock_irqsave(&hil_mlcs_lock, flags);
971 list_for_each(tmp, &hil_mlcs)
972 if (list_entry(tmp, hil_mlc, list) == mlc)
973 goto found;
975 /* not found in list */
976 write_unlock_irqrestore(&hil_mlcs_lock, flags);
977 tasklet_schedule(&hil_mlcs_tasklet);
978 return -ENODEV;
980 found:
981 list_del(tmp);
982 write_unlock_irqrestore(&hil_mlcs_lock, flags);
984 for (i = 0; i < HIL_MLC_DEVMEM; i++) {
985 serio_unregister_port(mlc->serio[i]);
986 mlc->serio[i] = NULL;
989 tasklet_schedule(&hil_mlcs_tasklet);
990 return 0;
993 /**************************** Module interface *************************/
995 static int __init hil_mlc_init(void)
997 setup_timer(&hil_mlcs_kicker, &hil_mlcs_timer, 0);
998 mod_timer(&hil_mlcs_kicker, jiffies + HZ);
1000 tasklet_enable(&hil_mlcs_tasklet);
1002 return 0;
1005 static void __exit hil_mlc_exit(void)
1007 del_timer_sync(&hil_mlcs_kicker);
1009 tasklet_disable(&hil_mlcs_tasklet);
1010 tasklet_kill(&hil_mlcs_tasklet);
1013 module_init(hil_mlc_init);
1014 module_exit(hil_mlc_exit);