fcb6ec1af173dfe22e3130ef6016f348c3f24858
[linux-2.6.git] / drivers / misc / kgdbts.c
1 /*
2  * kgdbts is a test suite for kgdb for the sole purpose of validating
3  * that key pieces of the kgdb internals are working properly such as
4  * HW/SW breakpoints, single stepping, and NMI.
5  *
6  * Created by: Jason Wessel <jason.wessel@windriver.com>
7  *
8  * Copyright (c) 2008 Wind River Systems, Inc.
9  *
10  * This program is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License version 2 as
12  * published by the Free Software Foundation.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
17  * See the GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software
21  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
22  */
23 /* Information about the kgdb test suite.
24  * -------------------------------------
25  *
26  * The kgdb test suite is designed as a KGDB I/O module which
27  * simulates the communications that a debugger would have with kgdb.
28  * The tests are broken up in to a line by line and referenced here as
29  * a "get" which is kgdb requesting input and "put" which is kgdb
30  * sending a response.
31  *
32  * The kgdb suite can be invoked from the kernel command line
33  * arguments system or executed dynamically at run time.  The test
34  * suite uses the variable "kgdbts" to obtain the information about
35  * which tests to run and to configure the verbosity level.  The
36  * following are the various characters you can use with the kgdbts=
37  * line:
38  *
39  * When using the "kgdbts=" you only choose one of the following core
40  * test types:
41  * A = Run all the core tests silently
42  * V1 = Run all the core tests with minimal output
43  * V2 = Run all the core tests in debug mode
44  *
45  * You can also specify optional tests:
46  * N## = Go to sleep with interrupts of for ## seconds
47  *       to test the HW NMI watchdog
48  * F## = Break at do_fork for ## iterations
49  * S## = Break at sys_open for ## iterations
50  * I## = Run the single step test ## iterations
51  *
52  * NOTE: that the do_fork and sys_open tests are mutually exclusive.
53  *
54  * To invoke the kgdb test suite from boot you use a kernel start
55  * argument as follows:
56  *      kgdbts=V1 kgdbwait
57  * Or if you wanted to perform the NMI test for 6 seconds and do_fork
58  * test for 100 forks, you could use:
59  *      kgdbts=V1N6F100 kgdbwait
60  *
61  * The test suite can also be invoked at run time with:
62  *      echo kgdbts=V1N6F100 > /sys/module/kgdbts/parameters/kgdbts
63  * Or as another example:
64  *      echo kgdbts=V2 > /sys/module/kgdbts/parameters/kgdbts
65  *
66  * When developing a new kgdb arch specific implementation or
67  * using these tests for the purpose of regression testing,
68  * several invocations are required.
69  *
70  * 1) Boot with the test suite enabled by using the kernel arguments
71  *       "kgdbts=V1F100 kgdbwait"
72  *    ## If kgdb arch specific implementation has NMI use
73  *       "kgdbts=V1N6F100
74  *
75  * 2) After the system boot run the basic test.
76  * echo kgdbts=V1 > /sys/module/kgdbts/parameters/kgdbts
77  *
78  * 3) Run the concurrency tests.  It is best to use n+1
79  *    while loops where n is the number of cpus you have
80  *    in your system.  The example below uses only two
81  *    loops.
82  *
83  * ## This tests break points on sys_open
84  * while [ 1 ] ; do find / > /dev/null 2>&1 ; done &
85  * while [ 1 ] ; do find / > /dev/null 2>&1 ; done &
86  * echo kgdbts=V1S10000 > /sys/module/kgdbts/parameters/kgdbts
87  * fg # and hit control-c
88  * fg # and hit control-c
89  * ## This tests break points on do_fork
90  * while [ 1 ] ; do date > /dev/null ; done &
91  * while [ 1 ] ; do date > /dev/null ; done &
92  * echo kgdbts=V1F1000 > /sys/module/kgdbts/parameters/kgdbts
93  * fg # and hit control-c
94  *
95  */
96
97 #include <linux/kernel.h>
98 #include <linux/kgdb.h>
99 #include <linux/ctype.h>
100 #include <linux/uaccess.h>
101 #include <linux/syscalls.h>
102 #include <linux/nmi.h>
103 #include <linux/delay.h>
104 #include <linux/kthread.h>
105
106 #define v1printk(a...) do { \
107         if (verbose) \
108                 printk(KERN_INFO a); \
109         } while (0)
110 #define v2printk(a...) do { \
111         if (verbose > 1) \
112                 printk(KERN_INFO a); \
113                 touch_nmi_watchdog();   \
114         } while (0)
115 #define eprintk(a...) do { \
116                 printk(KERN_ERR a); \
117                 WARN_ON(1); \
118         } while (0)
119 #define MAX_CONFIG_LEN          40
120
121 static struct kgdb_io kgdbts_io_ops;
122 static char get_buf[BUFMAX];
123 static int get_buf_cnt;
124 static char put_buf[BUFMAX];
125 static int put_buf_cnt;
126 static char scratch_buf[BUFMAX];
127 static int verbose;
128 static int repeat_test;
129 static int test_complete;
130 static int send_ack;
131 static int final_ack;
132 static int force_hwbrks;
133 static int hwbreaks_ok;
134 static int hw_break_val;
135 static int hw_break_val2;
136 #if defined(CONFIG_ARM) || defined(CONFIG_MIPS) || defined(CONFIG_SPARC)
137 static int arch_needs_sstep_emulation = 1;
138 #else
139 static int arch_needs_sstep_emulation;
140 #endif
141 static unsigned long sstep_addr;
142 static int sstep_state;
143
144 /* Storage for the registers, in GDB format. */
145 static unsigned long kgdbts_gdb_regs[(NUMREGBYTES +
146                                         sizeof(unsigned long) - 1) /
147                                         sizeof(unsigned long)];
148 static struct pt_regs kgdbts_regs;
149
150 /* -1 = init not run yet, 0 = unconfigured, 1 = configured. */
151 static int configured           = -1;
152
153 #ifdef CONFIG_KGDB_TESTS_BOOT_STRING
154 static char config[MAX_CONFIG_LEN] = CONFIG_KGDB_TESTS_BOOT_STRING;
155 #else
156 static char config[MAX_CONFIG_LEN];
157 #endif
158 static struct kparam_string kps = {
159         .string                 = config,
160         .maxlen                 = MAX_CONFIG_LEN,
161 };
162
163 static void fill_get_buf(char *buf);
164
165 struct test_struct {
166         char *get;
167         char *put;
168         void (*get_handler)(char *);
169         int (*put_handler)(char *, char *);
170 };
171
172 struct test_state {
173         char *name;
174         struct test_struct *tst;
175         int idx;
176         int (*run_test) (int, int);
177         int (*validate_put) (char *);
178 };
179
180 static struct test_state ts;
181
182 static int kgdbts_unreg_thread(void *ptr)
183 {
184         /* Wait until the tests are complete and then ungresiter the I/O
185          * driver.
186          */
187         while (!final_ack)
188                 msleep_interruptible(1500);
189
190         if (configured)
191                 kgdb_unregister_io_module(&kgdbts_io_ops);
192         configured = 0;
193
194         return 0;
195 }
196
197 /* This is noinline such that it can be used for a single location to
198  * place a breakpoint
199  */
200 static noinline void kgdbts_break_test(void)
201 {
202         v2printk("kgdbts: breakpoint complete\n");
203 }
204
205 /* Lookup symbol info in the kernel */
206 static unsigned long lookup_addr(char *arg)
207 {
208         unsigned long addr = 0;
209
210         if (!strcmp(arg, "kgdbts_break_test"))
211                 addr = (unsigned long)kgdbts_break_test;
212         else if (!strcmp(arg, "sys_open"))
213                 addr = (unsigned long)sys_open;
214         else if (!strcmp(arg, "do_fork"))
215                 addr = (unsigned long)do_fork;
216         else if (!strcmp(arg, "hw_break_val"))
217                 addr = (unsigned long)&hw_break_val;
218         return addr;
219 }
220
221 static void break_helper(char *bp_type, char *arg, unsigned long vaddr)
222 {
223         unsigned long addr;
224
225         if (arg)
226                 addr = lookup_addr(arg);
227         else
228                 addr = vaddr;
229
230         sprintf(scratch_buf, "%s,%lx,%i", bp_type, addr,
231                 BREAK_INSTR_SIZE);
232         fill_get_buf(scratch_buf);
233 }
234
235 static void sw_break(char *arg)
236 {
237         break_helper(force_hwbrks ? "Z1" : "Z0", arg, 0);
238 }
239
240 static void sw_rem_break(char *arg)
241 {
242         break_helper(force_hwbrks ? "z1" : "z0", arg, 0);
243 }
244
245 static void hw_break(char *arg)
246 {
247         break_helper("Z1", arg, 0);
248 }
249
250 static void hw_rem_break(char *arg)
251 {
252         break_helper("z1", arg, 0);
253 }
254
255 static void hw_write_break(char *arg)
256 {
257         break_helper("Z2", arg, 0);
258 }
259
260 static void hw_rem_write_break(char *arg)
261 {
262         break_helper("z2", arg, 0);
263 }
264
265 static void hw_access_break(char *arg)
266 {
267         break_helper("Z4", arg, 0);
268 }
269
270 static void hw_rem_access_break(char *arg)
271 {
272         break_helper("z4", arg, 0);
273 }
274
275 static void hw_break_val_access(void)
276 {
277         hw_break_val2 = hw_break_val;
278 }
279
280 static void hw_break_val_write(void)
281 {
282         hw_break_val++;
283 }
284
285 static int check_and_rewind_pc(char *put_str, char *arg)
286 {
287         unsigned long addr = lookup_addr(arg);
288         int offset = 0;
289
290         kgdb_hex2mem(&put_str[1], (char *)kgdbts_gdb_regs,
291                  NUMREGBYTES);
292         gdb_regs_to_pt_regs(kgdbts_gdb_regs, &kgdbts_regs);
293         v2printk("Stopped at IP: %lx\n", instruction_pointer(&kgdbts_regs));
294 #ifdef CONFIG_X86
295         /* On x86 a breakpoint stop requires it to be decremented */
296         if (addr + 1 == kgdbts_regs.ip)
297                 offset = -1;
298 #endif
299         if (strcmp(arg, "silent") &&
300                 instruction_pointer(&kgdbts_regs) + offset != addr) {
301                 eprintk("kgdbts: BP mismatch %lx expected %lx\n",
302                            instruction_pointer(&kgdbts_regs) + offset, addr);
303                 return 1;
304         }
305 #ifdef CONFIG_X86
306         /* On x86 adjust the instruction pointer if needed */
307         kgdbts_regs.ip += offset;
308 #endif
309         return 0;
310 }
311
312 static int check_single_step(char *put_str, char *arg)
313 {
314         unsigned long addr = lookup_addr(arg);
315         /*
316          * From an arch indepent point of view the instruction pointer
317          * should be on a different instruction
318          */
319         kgdb_hex2mem(&put_str[1], (char *)kgdbts_gdb_regs,
320                  NUMREGBYTES);
321         gdb_regs_to_pt_regs(kgdbts_gdb_regs, &kgdbts_regs);
322         v2printk("Singlestep stopped at IP: %lx\n",
323                    instruction_pointer(&kgdbts_regs));
324         if (instruction_pointer(&kgdbts_regs) == addr) {
325                 eprintk("kgdbts: SingleStep failed at %lx\n",
326                            instruction_pointer(&kgdbts_regs));
327                 return 1;
328         }
329
330         return 0;
331 }
332
333 static void write_regs(char *arg)
334 {
335         memset(scratch_buf, 0, sizeof(scratch_buf));
336         scratch_buf[0] = 'G';
337         pt_regs_to_gdb_regs(kgdbts_gdb_regs, &kgdbts_regs);
338         kgdb_mem2hex((char *)kgdbts_gdb_regs, &scratch_buf[1], NUMREGBYTES);
339         fill_get_buf(scratch_buf);
340 }
341
342 static void skip_back_repeat_test(char *arg)
343 {
344         int go_back = simple_strtol(arg, NULL, 10);
345
346         repeat_test--;
347         if (repeat_test <= 0)
348                 ts.idx++;
349         else
350                 ts.idx -= go_back;
351         fill_get_buf(ts.tst[ts.idx].get);
352 }
353
354 static int got_break(char *put_str, char *arg)
355 {
356         test_complete = 1;
357         if (!strncmp(put_str+1, arg, 2)) {
358                 if (!strncmp(arg, "T0", 2))
359                         test_complete = 2;
360                 return 0;
361         }
362         return 1;
363 }
364
365 static void emul_sstep_get(char *arg)
366 {
367         if (!arch_needs_sstep_emulation) {
368                 fill_get_buf(arg);
369                 return;
370         }
371         switch (sstep_state) {
372         case 0:
373                 v2printk("Emulate single step\n");
374                 /* Start by looking at the current PC */
375                 fill_get_buf("g");
376                 break;
377         case 1:
378                 /* set breakpoint */
379                 break_helper("Z0", NULL, sstep_addr);
380                 break;
381         case 2:
382                 /* Continue */
383                 fill_get_buf("c");
384                 break;
385         case 3:
386                 /* Clear breakpoint */
387                 break_helper("z0", NULL, sstep_addr);
388                 break;
389         default:
390                 eprintk("kgdbts: ERROR failed sstep get emulation\n");
391         }
392         sstep_state++;
393 }
394
395 static int emul_sstep_put(char *put_str, char *arg)
396 {
397         if (!arch_needs_sstep_emulation) {
398                 if (!strncmp(put_str+1, arg, 2))
399                         return 0;
400                 return 1;
401         }
402         switch (sstep_state) {
403         case 1:
404                 /* validate the "g" packet to get the IP */
405                 kgdb_hex2mem(&put_str[1], (char *)kgdbts_gdb_regs,
406                          NUMREGBYTES);
407                 gdb_regs_to_pt_regs(kgdbts_gdb_regs, &kgdbts_regs);
408                 v2printk("Stopped at IP: %lx\n",
409                          instruction_pointer(&kgdbts_regs));
410                 /* Want to stop at IP + break instruction size by default */
411                 sstep_addr = instruction_pointer(&kgdbts_regs) +
412                         BREAK_INSTR_SIZE;
413                 break;
414         case 2:
415                 if (strncmp(put_str, "$OK", 3)) {
416                         eprintk("kgdbts: failed sstep break set\n");
417                         return 1;
418                 }
419                 break;
420         case 3:
421                 if (strncmp(put_str, "$T0", 3)) {
422                         eprintk("kgdbts: failed continue sstep\n");
423                         return 1;
424                 }
425                 break;
426         case 4:
427                 if (strncmp(put_str, "$OK", 3)) {
428                         eprintk("kgdbts: failed sstep break unset\n");
429                         return 1;
430                 }
431                 /* Single step is complete so continue on! */
432                 sstep_state = 0;
433                 return 0;
434         default:
435                 eprintk("kgdbts: ERROR failed sstep put emulation\n");
436         }
437
438         /* Continue on the same test line until emulation is complete */
439         ts.idx--;
440         return 0;
441 }
442
443 static int final_ack_set(char *put_str, char *arg)
444 {
445         if (strncmp(put_str+1, arg, 2))
446                 return 1;
447         final_ack = 1;
448         return 0;
449 }
450 /*
451  * Test to plant a breakpoint and detach, which should clear out the
452  * breakpoint and restore the original instruction.
453  */
454 static struct test_struct plant_and_detach_test[] = {
455         { "?", "S0*" }, /* Clear break points */
456         { "kgdbts_break_test", "OK", sw_break, }, /* set sw breakpoint */
457         { "D", "OK" }, /* Detach */
458         { "", "" },
459 };
460
461 /*
462  * Simple test to write in a software breakpoint, check for the
463  * correct stop location and detach.
464  */
465 static struct test_struct sw_breakpoint_test[] = {
466         { "?", "S0*" }, /* Clear break points */
467         { "kgdbts_break_test", "OK", sw_break, }, /* set sw breakpoint */
468         { "c", "T0*", }, /* Continue */
469         { "g", "kgdbts_break_test", NULL, check_and_rewind_pc },
470         { "write", "OK", write_regs },
471         { "kgdbts_break_test", "OK", sw_rem_break }, /*remove breakpoint */
472         { "D", "OK" }, /* Detach */
473         { "D", "OK", NULL,  got_break }, /* On success we made it here */
474         { "", "" },
475 };
476
477 /*
478  * Test a known bad memory read location to test the fault handler and
479  * read bytes 1-8 at the bad address
480  */
481 static struct test_struct bad_read_test[] = {
482         { "?", "S0*" }, /* Clear break points */
483         { "m0,1", "E*" }, /* read 1 byte at address 1 */
484         { "m0,2", "E*" }, /* read 1 byte at address 2 */
485         { "m0,3", "E*" }, /* read 1 byte at address 3 */
486         { "m0,4", "E*" }, /* read 1 byte at address 4 */
487         { "m0,5", "E*" }, /* read 1 byte at address 5 */
488         { "m0,6", "E*" }, /* read 1 byte at address 6 */
489         { "m0,7", "E*" }, /* read 1 byte at address 7 */
490         { "m0,8", "E*" }, /* read 1 byte at address 8 */
491         { "D", "OK" }, /* Detach which removes all breakpoints and continues */
492         { "", "" },
493 };
494
495 /*
496  * Test for hitting a breakpoint, remove it, single step, plant it
497  * again and detach.
498  */
499 static struct test_struct singlestep_break_test[] = {
500         { "?", "S0*" }, /* Clear break points */
501         { "kgdbts_break_test", "OK", sw_break, }, /* set sw breakpoint */
502         { "c", "T0*", }, /* Continue */
503         { "g", "kgdbts_break_test", NULL, check_and_rewind_pc },
504         { "write", "OK", write_regs }, /* Write registers */
505         { "kgdbts_break_test", "OK", sw_rem_break }, /*remove breakpoint */
506         { "s", "T0*", emul_sstep_get, emul_sstep_put }, /* Single step */
507         { "g", "kgdbts_break_test", NULL, check_single_step },
508         { "kgdbts_break_test", "OK", sw_break, }, /* set sw breakpoint */
509         { "c", "T0*", }, /* Continue */
510         { "g", "kgdbts_break_test", NULL, check_and_rewind_pc },
511         { "write", "OK", write_regs }, /* Write registers */
512         { "D", "OK" }, /* Remove all breakpoints and continues */
513         { "", "" },
514 };
515
516 /*
517  * Test for hitting a breakpoint at do_fork for what ever the number
518  * of iterations required by the variable repeat_test.
519  */
520 static struct test_struct do_fork_test[] = {
521         { "?", "S0*" }, /* Clear break points */
522         { "do_fork", "OK", sw_break, }, /* set sw breakpoint */
523         { "c", "T0*", }, /* Continue */
524         { "g", "do_fork", NULL, check_and_rewind_pc }, /* check location */
525         { "write", "OK", write_regs }, /* Write registers */
526         { "do_fork", "OK", sw_rem_break }, /*remove breakpoint */
527         { "s", "T0*", emul_sstep_get, emul_sstep_put }, /* Single step */
528         { "g", "do_fork", NULL, check_single_step },
529         { "do_fork", "OK", sw_break, }, /* set sw breakpoint */
530         { "7", "T0*", skip_back_repeat_test }, /* Loop based on repeat_test */
531         { "D", "OK", NULL, final_ack_set }, /* detach and unregister I/O */
532         { "", "" },
533 };
534
535 /* Test for hitting a breakpoint at sys_open for what ever the number
536  * of iterations required by the variable repeat_test.
537  */
538 static struct test_struct sys_open_test[] = {
539         { "?", "S0*" }, /* Clear break points */
540         { "sys_open", "OK", sw_break, }, /* set sw breakpoint */
541         { "c", "T0*", }, /* Continue */
542         { "g", "sys_open", NULL, check_and_rewind_pc }, /* check location */
543         { "write", "OK", write_regs }, /* Write registers */
544         { "sys_open", "OK", sw_rem_break }, /*remove breakpoint */
545         { "s", "T0*", emul_sstep_get, emul_sstep_put }, /* Single step */
546         { "g", "sys_open", NULL, check_single_step },
547         { "sys_open", "OK", sw_break, }, /* set sw breakpoint */
548         { "7", "T0*", skip_back_repeat_test }, /* Loop based on repeat_test */
549         { "D", "OK", NULL, final_ack_set }, /* detach and unregister I/O */
550         { "", "" },
551 };
552
553 /*
554  * Test for hitting a simple hw breakpoint
555  */
556 static struct test_struct hw_breakpoint_test[] = {
557         { "?", "S0*" }, /* Clear break points */
558         { "kgdbts_break_test", "OK", hw_break, }, /* set hw breakpoint */
559         { "c", "T0*", }, /* Continue */
560         { "g", "kgdbts_break_test", NULL, check_and_rewind_pc },
561         { "write", "OK", write_regs },
562         { "kgdbts_break_test", "OK", hw_rem_break }, /*remove breakpoint */
563         { "D", "OK" }, /* Detach */
564         { "D", "OK", NULL,  got_break }, /* On success we made it here */
565         { "", "" },
566 };
567
568 /*
569  * Test for hitting a hw write breakpoint
570  */
571 static struct test_struct hw_write_break_test[] = {
572         { "?", "S0*" }, /* Clear break points */
573         { "hw_break_val", "OK", hw_write_break, }, /* set hw breakpoint */
574         { "c", "T0*", NULL, got_break }, /* Continue */
575         { "g", "silent", NULL, check_and_rewind_pc },
576         { "write", "OK", write_regs },
577         { "hw_break_val", "OK", hw_rem_write_break }, /*remove breakpoint */
578         { "D", "OK" }, /* Detach */
579         { "D", "OK", NULL,  got_break }, /* On success we made it here */
580         { "", "" },
581 };
582
583 /*
584  * Test for hitting a hw access breakpoint
585  */
586 static struct test_struct hw_access_break_test[] = {
587         { "?", "S0*" }, /* Clear break points */
588         { "hw_break_val", "OK", hw_access_break, }, /* set hw breakpoint */
589         { "c", "T0*", NULL, got_break }, /* Continue */
590         { "g", "silent", NULL, check_and_rewind_pc },
591         { "write", "OK", write_regs },
592         { "hw_break_val", "OK", hw_rem_access_break }, /*remove breakpoint */
593         { "D", "OK" }, /* Detach */
594         { "D", "OK", NULL,  got_break }, /* On success we made it here */
595         { "", "" },
596 };
597
598 /*
599  * Test for hitting a hw access breakpoint
600  */
601 static struct test_struct nmi_sleep_test[] = {
602         { "?", "S0*" }, /* Clear break points */
603         { "c", "T0*", NULL, got_break }, /* Continue */
604         { "D", "OK" }, /* Detach */
605         { "D", "OK", NULL,  got_break }, /* On success we made it here */
606         { "", "" },
607 };
608
609 static void fill_get_buf(char *buf)
610 {
611         unsigned char checksum = 0;
612         int count = 0;
613         char ch;
614
615         strcpy(get_buf, "$");
616         strcat(get_buf, buf);
617         while ((ch = buf[count])) {
618                 checksum += ch;
619                 count++;
620         }
621         strcat(get_buf, "#");
622         get_buf[count + 2] = hex_asc_hi(checksum);
623         get_buf[count + 3] = hex_asc_lo(checksum);
624         get_buf[count + 4] = '\0';
625         v2printk("get%i: %s\n", ts.idx, get_buf);
626 }
627
628 static int validate_simple_test(char *put_str)
629 {
630         char *chk_str;
631
632         if (ts.tst[ts.idx].put_handler)
633                 return ts.tst[ts.idx].put_handler(put_str,
634                         ts.tst[ts.idx].put);
635
636         chk_str = ts.tst[ts.idx].put;
637         if (*put_str == '$')
638                 put_str++;
639
640         while (*chk_str != '\0' && *put_str != '\0') {
641                 /* If someone does a * to match the rest of the string, allow
642                  * it, or stop if the recieved string is complete.
643                  */
644                 if (*put_str == '#' || *chk_str == '*')
645                         return 0;
646                 if (*put_str != *chk_str)
647                         return 1;
648
649                 chk_str++;
650                 put_str++;
651         }
652         if (*chk_str == '\0' && (*put_str == '\0' || *put_str == '#'))
653                 return 0;
654
655         return 1;
656 }
657
658 static int run_simple_test(int is_get_char, int chr)
659 {
660         int ret = 0;
661         if (is_get_char) {
662                 /* Send an ACK on the get if a prior put completed and set the
663                  * send ack variable
664                  */
665                 if (send_ack) {
666                         send_ack = 0;
667                         return '+';
668                 }
669                 /* On the first get char, fill the transmit buffer and then
670                  * take from the get_string.
671                  */
672                 if (get_buf_cnt == 0) {
673                         if (ts.tst[ts.idx].get_handler)
674                                 ts.tst[ts.idx].get_handler(ts.tst[ts.idx].get);
675                         else
676                                 fill_get_buf(ts.tst[ts.idx].get);
677                 }
678
679                 if (get_buf[get_buf_cnt] == '\0') {
680                         eprintk("kgdbts: ERROR GET: EOB on '%s' at %i\n",
681                            ts.name, ts.idx);
682                         get_buf_cnt = 0;
683                         fill_get_buf("D");
684                 }
685                 ret = get_buf[get_buf_cnt];
686                 get_buf_cnt++;
687                 return ret;
688         }
689
690         /* This callback is a put char which is when kgdb sends data to
691          * this I/O module.
692          */
693         if (ts.tst[ts.idx].get[0] == '\0' &&
694                 ts.tst[ts.idx].put[0] == '\0') {
695                 eprintk("kgdbts: ERROR: beyond end of test on"
696                            " '%s' line %i\n", ts.name, ts.idx);
697                 return 0;
698         }
699
700         if (put_buf_cnt >= BUFMAX) {
701                 eprintk("kgdbts: ERROR: put buffer overflow on"
702                            " '%s' line %i\n", ts.name, ts.idx);
703                 put_buf_cnt = 0;
704                 return 0;
705         }
706         /* Ignore everything until the first valid packet start '$' */
707         if (put_buf_cnt == 0 && chr != '$')
708                 return 0;
709
710         put_buf[put_buf_cnt] = chr;
711         put_buf_cnt++;
712
713         /* End of packet == #XX so look for the '#' */
714         if (put_buf_cnt > 3 && put_buf[put_buf_cnt - 3] == '#') {
715                 if (put_buf_cnt >= BUFMAX) {
716                         eprintk("kgdbts: ERROR: put buffer overflow on"
717                                 " '%s' line %i\n", ts.name, ts.idx);
718                         put_buf_cnt = 0;
719                         return 0;
720                 }
721                 put_buf[put_buf_cnt] = '\0';
722                 v2printk("put%i: %s\n", ts.idx, put_buf);
723                 /* Trigger check here */
724                 if (ts.validate_put && ts.validate_put(put_buf)) {
725                         eprintk("kgdbts: ERROR PUT: end of test "
726                            "buffer on '%s' line %i expected %s got %s\n",
727                            ts.name, ts.idx, ts.tst[ts.idx].put, put_buf);
728                 }
729                 ts.idx++;
730                 put_buf_cnt = 0;
731                 get_buf_cnt = 0;
732                 send_ack = 1;
733         }
734         return 0;
735 }
736
737 static void init_simple_test(void)
738 {
739         memset(&ts, 0, sizeof(ts));
740         ts.run_test = run_simple_test;
741         ts.validate_put = validate_simple_test;
742 }
743
744 static void run_plant_and_detach_test(int is_early)
745 {
746         char before[BREAK_INSTR_SIZE];
747         char after[BREAK_INSTR_SIZE];
748
749         probe_kernel_read(before, (char *)kgdbts_break_test,
750           BREAK_INSTR_SIZE);
751         init_simple_test();
752         ts.tst = plant_and_detach_test;
753         ts.name = "plant_and_detach_test";
754         /* Activate test with initial breakpoint */
755         if (!is_early)
756                 kgdb_breakpoint();
757         probe_kernel_read(after, (char *)kgdbts_break_test,
758           BREAK_INSTR_SIZE);
759         if (memcmp(before, after, BREAK_INSTR_SIZE)) {
760                 printk(KERN_CRIT "kgdbts: ERROR kgdb corrupted memory\n");
761                 panic("kgdb memory corruption");
762         }
763
764         /* complete the detach test */
765         if (!is_early)
766                 kgdbts_break_test();
767 }
768
769 static void run_breakpoint_test(int is_hw_breakpoint)
770 {
771         test_complete = 0;
772         init_simple_test();
773         if (is_hw_breakpoint) {
774                 ts.tst = hw_breakpoint_test;
775                 ts.name = "hw_breakpoint_test";
776         } else {
777                 ts.tst = sw_breakpoint_test;
778                 ts.name = "sw_breakpoint_test";
779         }
780         /* Activate test with initial breakpoint */
781         kgdb_breakpoint();
782         /* run code with the break point in it */
783         kgdbts_break_test();
784         kgdb_breakpoint();
785
786         if (test_complete)
787                 return;
788
789         eprintk("kgdbts: ERROR %s test failed\n", ts.name);
790         if (is_hw_breakpoint)
791                 hwbreaks_ok = 0;
792 }
793
794 static void run_hw_break_test(int is_write_test)
795 {
796         test_complete = 0;
797         init_simple_test();
798         if (is_write_test) {
799                 ts.tst = hw_write_break_test;
800                 ts.name = "hw_write_break_test";
801         } else {
802                 ts.tst = hw_access_break_test;
803                 ts.name = "hw_access_break_test";
804         }
805         /* Activate test with initial breakpoint */
806         kgdb_breakpoint();
807         hw_break_val_access();
808         if (is_write_test) {
809                 if (test_complete == 2) {
810                         eprintk("kgdbts: ERROR %s broke on access\n",
811                                 ts.name);
812                         hwbreaks_ok = 0;
813                 }
814                 hw_break_val_write();
815         }
816         kgdb_breakpoint();
817
818         if (test_complete == 1)
819                 return;
820
821         eprintk("kgdbts: ERROR %s test failed\n", ts.name);
822         hwbreaks_ok = 0;
823 }
824
825 static void run_nmi_sleep_test(int nmi_sleep)
826 {
827         unsigned long flags;
828
829         init_simple_test();
830         ts.tst = nmi_sleep_test;
831         ts.name = "nmi_sleep_test";
832         /* Activate test with initial breakpoint */
833         kgdb_breakpoint();
834         local_irq_save(flags);
835         mdelay(nmi_sleep*1000);
836         touch_nmi_watchdog();
837         local_irq_restore(flags);
838         if (test_complete != 2)
839                 eprintk("kgdbts: ERROR nmi_test did not hit nmi\n");
840         kgdb_breakpoint();
841         if (test_complete == 1)
842                 return;
843
844         eprintk("kgdbts: ERROR %s test failed\n", ts.name);
845 }
846
847 static void run_bad_read_test(void)
848 {
849         init_simple_test();
850         ts.tst = bad_read_test;
851         ts.name = "bad_read_test";
852         /* Activate test with initial breakpoint */
853         kgdb_breakpoint();
854 }
855
856 static void run_do_fork_test(void)
857 {
858         init_simple_test();
859         ts.tst = do_fork_test;
860         ts.name = "do_fork_test";
861         /* Activate test with initial breakpoint */
862         kgdb_breakpoint();
863 }
864
865 static void run_sys_open_test(void)
866 {
867         init_simple_test();
868         ts.tst = sys_open_test;
869         ts.name = "sys_open_test";
870         /* Activate test with initial breakpoint */
871         kgdb_breakpoint();
872 }
873
874 static void run_singlestep_break_test(void)
875 {
876         init_simple_test();
877         ts.tst = singlestep_break_test;
878         ts.name = "singlestep_breakpoint_test";
879         /* Activate test with initial breakpoint */
880         kgdb_breakpoint();
881         kgdbts_break_test();
882         kgdbts_break_test();
883 }
884
885 static void kgdbts_run_tests(void)
886 {
887         char *ptr;
888         int fork_test = 0;
889         int do_sys_open_test = 0;
890         int sstep_test = 1000;
891         int nmi_sleep = 0;
892         int i;
893
894         ptr = strchr(config, 'F');
895         if (ptr)
896                 fork_test = simple_strtol(ptr + 1, NULL, 10);
897         ptr = strchr(config, 'S');
898         if (ptr)
899                 do_sys_open_test = simple_strtol(ptr + 1, NULL, 10);
900         ptr = strchr(config, 'N');
901         if (ptr)
902                 nmi_sleep = simple_strtol(ptr+1, NULL, 10);
903         ptr = strchr(config, 'I');
904         if (ptr)
905                 sstep_test = simple_strtol(ptr+1, NULL, 10);
906
907         /* required internal KGDB tests */
908         v1printk("kgdbts:RUN plant and detach test\n");
909         run_plant_and_detach_test(0);
910         v1printk("kgdbts:RUN sw breakpoint test\n");
911         run_breakpoint_test(0);
912         v1printk("kgdbts:RUN bad memory access test\n");
913         run_bad_read_test();
914         v1printk("kgdbts:RUN singlestep test %i iterations\n", sstep_test);
915         for (i = 0; i < sstep_test; i++) {
916                 run_singlestep_break_test();
917                 if (i % 100 == 0)
918                         v1printk("kgdbts:RUN singlestep [%i/%i]\n",
919                                  i, sstep_test);
920         }
921
922         /* ===Optional tests=== */
923
924         /* All HW break point tests */
925         if (arch_kgdb_ops.flags & KGDB_HW_BREAKPOINT) {
926                 hwbreaks_ok = 1;
927                 v1printk("kgdbts:RUN hw breakpoint test\n");
928                 run_breakpoint_test(1);
929                 v1printk("kgdbts:RUN hw write breakpoint test\n");
930                 run_hw_break_test(1);
931                 v1printk("kgdbts:RUN access write breakpoint test\n");
932                 run_hw_break_test(0);
933         }
934
935         if (nmi_sleep) {
936                 v1printk("kgdbts:RUN NMI sleep %i seconds test\n", nmi_sleep);
937                 run_nmi_sleep_test(nmi_sleep);
938         }
939
940 #ifdef CONFIG_DEBUG_RODATA
941         /* Until there is an api to write to read-only text segments, use
942          * HW breakpoints for the remainder of any tests, else print a
943          * failure message if hw breakpoints do not work.
944          */
945         if (!(arch_kgdb_ops.flags & KGDB_HW_BREAKPOINT && hwbreaks_ok)) {
946                 eprintk("kgdbts: HW breakpoints do not work,"
947                         "skipping remaining tests\n");
948                 return;
949         }
950         force_hwbrks = 1;
951 #endif /* CONFIG_DEBUG_RODATA */
952
953         /* If the do_fork test is run it will be the last test that is
954          * executed because a kernel thread will be spawned at the very
955          * end to unregister the debug hooks.
956          */
957         if (fork_test) {
958                 repeat_test = fork_test;
959                 printk(KERN_INFO "kgdbts:RUN do_fork for %i breakpoints\n",
960                         repeat_test);
961                 kthread_run(kgdbts_unreg_thread, NULL, "kgdbts_unreg");
962                 run_do_fork_test();
963                 return;
964         }
965
966         /* If the sys_open test is run it will be the last test that is
967          * executed because a kernel thread will be spawned at the very
968          * end to unregister the debug hooks.
969          */
970         if (do_sys_open_test) {
971                 repeat_test = do_sys_open_test;
972                 printk(KERN_INFO "kgdbts:RUN sys_open for %i breakpoints\n",
973                         repeat_test);
974                 kthread_run(kgdbts_unreg_thread, NULL, "kgdbts_unreg");
975                 run_sys_open_test();
976                 return;
977         }
978         /* Shutdown and unregister */
979         kgdb_unregister_io_module(&kgdbts_io_ops);
980         configured = 0;
981 }
982
983 static int kgdbts_option_setup(char *opt)
984 {
985         if (strlen(opt) > MAX_CONFIG_LEN) {
986                 printk(KERN_ERR "kgdbts: config string too long\n");
987                 return -ENOSPC;
988         }
989         strcpy(config, opt);
990
991         verbose = 0;
992         if (strstr(config, "V1"))
993                 verbose = 1;
994         if (strstr(config, "V2"))
995                 verbose = 2;
996
997         return 0;
998 }
999
1000 __setup("kgdbts=", kgdbts_option_setup);
1001
1002 static int configure_kgdbts(void)
1003 {
1004         int err = 0;
1005
1006         if (!strlen(config) || isspace(config[0]))
1007                 goto noconfig;
1008         err = kgdbts_option_setup(config);
1009         if (err)
1010                 goto noconfig;
1011
1012         final_ack = 0;
1013         run_plant_and_detach_test(1);
1014
1015         err = kgdb_register_io_module(&kgdbts_io_ops);
1016         if (err) {
1017                 configured = 0;
1018                 return err;
1019         }
1020         configured = 1;
1021         kgdbts_run_tests();
1022
1023         return err;
1024
1025 noconfig:
1026         config[0] = 0;
1027         configured = 0;
1028
1029         return err;
1030 }
1031
1032 static int __init init_kgdbts(void)
1033 {
1034         /* Already configured? */
1035         if (configured == 1)
1036                 return 0;
1037
1038         return configure_kgdbts();
1039 }
1040
1041 static void cleanup_kgdbts(void)
1042 {
1043         if (configured == 1)
1044                 kgdb_unregister_io_module(&kgdbts_io_ops);
1045 }
1046
1047 static int kgdbts_get_char(void)
1048 {
1049         int val = 0;
1050
1051         if (ts.run_test)
1052                 val = ts.run_test(1, 0);
1053
1054         return val;
1055 }
1056
1057 static void kgdbts_put_char(u8 chr)
1058 {
1059         if (ts.run_test)
1060                 ts.run_test(0, chr);
1061 }
1062
1063 static int param_set_kgdbts_var(const char *kmessage, struct kernel_param *kp)
1064 {
1065         int len = strlen(kmessage);
1066
1067         if (len >= MAX_CONFIG_LEN) {
1068                 printk(KERN_ERR "kgdbts: config string too long\n");
1069                 return -ENOSPC;
1070         }
1071
1072         /* Only copy in the string if the init function has not run yet */
1073         if (configured < 0) {
1074                 strcpy(config, kmessage);
1075                 return 0;
1076         }
1077
1078         if (kgdb_connected) {
1079                 printk(KERN_ERR
1080                "kgdbts: Cannot reconfigure while KGDB is connected.\n");
1081
1082                 return -EBUSY;
1083         }
1084
1085         strcpy(config, kmessage);
1086         /* Chop out \n char as a result of echo */
1087         if (config[len - 1] == '\n')
1088                 config[len - 1] = '\0';
1089
1090         if (configured == 1)
1091                 cleanup_kgdbts();
1092
1093         /* Go and configure with the new params. */
1094         return configure_kgdbts();
1095 }
1096
1097 static void kgdbts_pre_exp_handler(void)
1098 {
1099         /* Increment the module count when the debugger is active */
1100         if (!kgdb_connected)
1101                 try_module_get(THIS_MODULE);
1102 }
1103
1104 static void kgdbts_post_exp_handler(void)
1105 {
1106         /* decrement the module count when the debugger detaches */
1107         if (!kgdb_connected)
1108                 module_put(THIS_MODULE);
1109 }
1110
1111 static struct kgdb_io kgdbts_io_ops = {
1112         .name                   = "kgdbts",
1113         .read_char              = kgdbts_get_char,
1114         .write_char             = kgdbts_put_char,
1115         .pre_exception          = kgdbts_pre_exp_handler,
1116         .post_exception         = kgdbts_post_exp_handler,
1117 };
1118
1119 module_init(init_kgdbts);
1120 module_exit(cleanup_kgdbts);
1121 module_param_call(kgdbts, param_set_kgdbts_var, param_get_string, &kps, 0644);
1122 MODULE_PARM_DESC(kgdbts, "<A|V1|V2>[F#|S#][N#]");
1123 MODULE_DESCRIPTION("KGDB Test Suite");
1124 MODULE_LICENSE("GPL");
1125 MODULE_AUTHOR("Wind River Systems, Inc.");
1126