xref: /openbmc/linux/drivers/acpi/acpica/dbinput.c (revision a06c488d)
1 /*******************************************************************************
2  *
3  * Module Name: dbinput - user front-end to the AML debugger
4  *
5  ******************************************************************************/
6 
7 /*
8  * Copyright (C) 2000 - 2016, Intel Corp.
9  * All rights reserved.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  * 1. Redistributions of source code must retain the above copyright
15  *    notice, this list of conditions, and the following disclaimer,
16  *    without modification.
17  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18  *    substantially similar to the "NO WARRANTY" disclaimer below
19  *    ("Disclaimer") and any redistribution must be conditioned upon
20  *    including a substantially similar Disclaimer requirement for further
21  *    binary redistribution.
22  * 3. Neither the names of the above-listed copyright holders nor the names
23  *    of any contributors may be used to endorse or promote products derived
24  *    from this software without specific prior written permission.
25  *
26  * Alternatively, this software may be distributed under the terms of the
27  * GNU General Public License ("GPL") version 2 as published by the Free
28  * Software Foundation.
29  *
30  * NO WARRANTY
31  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41  * POSSIBILITY OF SUCH DAMAGES.
42  */
43 
44 #include <acpi/acpi.h>
45 #include "accommon.h"
46 #include "acdebug.h"
47 
48 #ifdef ACPI_APPLICATION
49 #include "acapps.h"
50 #endif
51 
52 #define _COMPONENT          ACPI_CA_DEBUGGER
53 ACPI_MODULE_NAME("dbinput")
54 
55 /* Local prototypes */
56 static u32 acpi_db_get_line(char *input_buffer);
57 
58 static u32 acpi_db_match_command(char *user_command);
59 
60 static void acpi_db_display_command_info(char *command, u8 display_all);
61 
62 static void acpi_db_display_help(char *command);
63 
64 static u8
65 acpi_db_match_command_help(char *command,
66 			   const struct acpi_db_command_help *help);
67 
68 /*
69  * Top-level debugger commands.
70  *
71  * This list of commands must match the string table below it
72  */
73 enum acpi_ex_debugger_commands {
74 	CMD_NOT_FOUND = 0,
75 	CMD_NULL,
76 	CMD_ALLOCATIONS,
77 	CMD_ARGS,
78 	CMD_ARGUMENTS,
79 	CMD_BREAKPOINT,
80 	CMD_BUSINFO,
81 	CMD_CALL,
82 	CMD_DEBUG,
83 	CMD_DISASSEMBLE,
84 	CMD_DISASM,
85 	CMD_DUMP,
86 	CMD_EVALUATE,
87 	CMD_EXECUTE,
88 	CMD_EXIT,
89 	CMD_FIND,
90 	CMD_GO,
91 	CMD_HANDLERS,
92 	CMD_HELP,
93 	CMD_HELP2,
94 	CMD_HISTORY,
95 	CMD_HISTORY_EXE,
96 	CMD_HISTORY_LAST,
97 	CMD_INFORMATION,
98 	CMD_INTEGRITY,
99 	CMD_INTO,
100 	CMD_LEVEL,
101 	CMD_LIST,
102 	CMD_LOCALS,
103 	CMD_LOCKS,
104 	CMD_METHODS,
105 	CMD_NAMESPACE,
106 	CMD_NOTIFY,
107 	CMD_OBJECTS,
108 	CMD_OSI,
109 	CMD_OWNER,
110 	CMD_PATHS,
111 	CMD_PREDEFINED,
112 	CMD_PREFIX,
113 	CMD_QUIT,
114 	CMD_REFERENCES,
115 	CMD_RESOURCES,
116 	CMD_RESULTS,
117 	CMD_SET,
118 	CMD_STATS,
119 	CMD_STOP,
120 	CMD_TABLES,
121 	CMD_TEMPLATE,
122 	CMD_TRACE,
123 	CMD_TREE,
124 	CMD_TYPE,
125 #ifdef ACPI_APPLICATION
126 	CMD_ENABLEACPI,
127 	CMD_EVENT,
128 	CMD_GPE,
129 	CMD_GPES,
130 	CMD_SCI,
131 	CMD_SLEEP,
132 
133 	CMD_CLOSE,
134 	CMD_LOAD,
135 	CMD_OPEN,
136 	CMD_UNLOAD,
137 
138 	CMD_TERMINATE,
139 	CMD_THREADS,
140 
141 	CMD_TEST,
142 #endif
143 };
144 
145 #define CMD_FIRST_VALID     2
146 
147 /* Second parameter is the required argument count */
148 
149 static const struct acpi_db_command_info acpi_gbl_db_commands[] = {
150 	{"<NOT FOUND>", 0},
151 	{"<NULL>", 0},
152 	{"ALLOCATIONS", 0},
153 	{"ARGS", 0},
154 	{"ARGUMENTS", 0},
155 	{"BREAKPOINT", 1},
156 	{"BUSINFO", 0},
157 	{"CALL", 0},
158 	{"DEBUG", 1},
159 	{"DISASSEMBLE", 1},
160 	{"DISASM", 1},
161 	{"DUMP", 1},
162 	{"EVALUATE", 1},
163 	{"EXECUTE", 1},
164 	{"EXIT", 0},
165 	{"FIND", 1},
166 	{"GO", 0},
167 	{"HANDLERS", 0},
168 	{"HELP", 0},
169 	{"?", 0},
170 	{"HISTORY", 0},
171 	{"!", 1},
172 	{"!!", 0},
173 	{"INFORMATION", 0},
174 	{"INTEGRITY", 0},
175 	{"INTO", 0},
176 	{"LEVEL", 0},
177 	{"LIST", 0},
178 	{"LOCALS", 0},
179 	{"LOCKS", 0},
180 	{"METHODS", 0},
181 	{"NAMESPACE", 0},
182 	{"NOTIFY", 2},
183 	{"OBJECTS", 0},
184 	{"OSI", 0},
185 	{"OWNER", 1},
186 	{"PATHS", 0},
187 	{"PREDEFINED", 0},
188 	{"PREFIX", 0},
189 	{"QUIT", 0},
190 	{"REFERENCES", 1},
191 	{"RESOURCES", 0},
192 	{"RESULTS", 0},
193 	{"SET", 3},
194 	{"STATS", 1},
195 	{"STOP", 0},
196 	{"TABLES", 0},
197 	{"TEMPLATE", 1},
198 	{"TRACE", 1},
199 	{"TREE", 0},
200 	{"TYPE", 1},
201 #ifdef ACPI_APPLICATION
202 	{"ENABLEACPI", 0},
203 	{"EVENT", 1},
204 	{"GPE", 1},
205 	{"GPES", 0},
206 	{"SCI", 0},
207 	{"SLEEP", 0},
208 
209 	{"CLOSE", 0},
210 	{"LOAD", 1},
211 	{"OPEN", 1},
212 	{"UNLOAD", 1},
213 
214 	{"TERMINATE", 0},
215 	{"THREADS", 3},
216 
217 	{"TEST", 1},
218 #endif
219 	{NULL, 0}
220 };
221 
222 /*
223  * Help for all debugger commands. First argument is the number of lines
224  * of help to output for the command.
225  */
226 static const struct acpi_db_command_help acpi_gbl_db_command_help[] = {
227 	{0, "\nGeneral-Purpose Commands:", "\n"},
228 	{1, "  Allocations", "Display list of current memory allocations\n"},
229 	{2, "  Dump <Address>|<Namepath>", "\n"},
230 	{0, "       [Byte|Word|Dword|Qword]",
231 	 "Display ACPI objects or memory\n"},
232 	{1, "  Handlers", "Info about global handlers\n"},
233 	{1, "  Help [Command]", "This help screen or individual command\n"},
234 	{1, "  History", "Display command history buffer\n"},
235 	{1, "  Level <DebugLevel>] [console]",
236 	 "Get/Set debug level for file or console\n"},
237 	{1, "  Locks", "Current status of internal mutexes\n"},
238 	{1, "  Osi [Install|Remove <name>]",
239 	 "Display or modify global _OSI list\n"},
240 	{1, "  Quit or Exit", "Exit this command\n"},
241 	{8, "  Stats <SubCommand>",
242 	 "Display namespace and memory statistics\n"},
243 	{1, "     Allocations", "Display list of current memory allocations\n"},
244 	{1, "     Memory", "Dump internal memory lists\n"},
245 	{1, "     Misc", "Namespace search and mutex stats\n"},
246 	{1, "     Objects", "Summary of namespace objects\n"},
247 	{1, "     Sizes", "Sizes for each of the internal objects\n"},
248 	{1, "     Stack", "Display CPU stack usage\n"},
249 	{1, "     Tables", "Info about current ACPI table(s)\n"},
250 	{1, "  Tables", "Display info about loaded ACPI tables\n"},
251 	{1, "  ! <CommandNumber>", "Execute command from history buffer\n"},
252 	{1, "  !!", "Execute last command again\n"},
253 
254 	{0, "\nNamespace Access Commands:", "\n"},
255 	{1, "  Businfo", "Display system bus info\n"},
256 	{1, "  Disassemble <Method>", "Disassemble a control method\n"},
257 	{1, "  Find <AcpiName> (? is wildcard)",
258 	 "Find ACPI name(s) with wildcards\n"},
259 	{1, "  Integrity", "Validate namespace integrity\n"},
260 	{1, "  Methods", "Display list of loaded control methods\n"},
261 	{1, "  Namespace [Object] [Depth]",
262 	 "Display loaded namespace tree/subtree\n"},
263 	{1, "  Notify <Object> <Value>", "Send a notification on Object\n"},
264 	{1, "  Objects [ObjectType]",
265 	 "Display summary of all objects or just given type\n"},
266 	{1, "  Owner <OwnerId> [Depth]",
267 	 "Display loaded namespace by object owner\n"},
268 	{1, "  Paths", "Display full pathnames of namespace objects\n"},
269 	{1, "  Predefined", "Check all predefined names\n"},
270 	{1, "  Prefix [<Namepath>]", "Set or Get current execution prefix\n"},
271 	{1, "  References <Addr>", "Find all references to object at addr\n"},
272 	{1, "  Resources [DeviceName]",
273 	 "Display Device resources (no arg = all devices)\n"},
274 	{1, "  Set N <NamedObject> <Value>", "Set value for named integer\n"},
275 	{1, "  Template <Object>", "Format/dump a Buffer/ResourceTemplate\n"},
276 	{1, "  Type <Object>", "Display object type\n"},
277 
278 	{0, "\nControl Method Execution Commands:", "\n"},
279 	{1, "  Arguments (or Args)", "Display method arguments\n"},
280 	{1, "  Breakpoint <AmlOffset>", "Set an AML execution breakpoint\n"},
281 	{1, "  Call", "Run to next control method invocation\n"},
282 	{1, "  Debug <Namepath> [Arguments]", "Single Step a control method\n"},
283 	{6, "  Evaluate", "Synonym for Execute\n"},
284 	{5, "  Execute <Namepath> [Arguments]", "Execute control method\n"},
285 	{1, "     Hex Integer", "Integer method argument\n"},
286 	{1, "     \"Ascii String\"", "String method argument\n"},
287 	{1, "     (Hex Byte List)", "Buffer method argument\n"},
288 	{1, "     [Package Element List]", "Package method argument\n"},
289 	{1, "  Go", "Allow method to run to completion\n"},
290 	{1, "  Information", "Display info about the current method\n"},
291 	{1, "  Into", "Step into (not over) a method call\n"},
292 	{1, "  List [# of Aml Opcodes]", "Display method ASL statements\n"},
293 	{1, "  Locals", "Display method local variables\n"},
294 	{1, "  Results", "Display method result stack\n"},
295 	{1, "  Set <A|L> <#> <Value>", "Set method data (Arguments/Locals)\n"},
296 	{1, "  Stop", "Terminate control method\n"},
297 	{5, "  Trace <State> [<Namepath>] [Once]",
298 	 "Trace control method execution\n"},
299 	{1, "     Enable", "Enable all messages\n"},
300 	{1, "     Disable", "Disable tracing\n"},
301 	{1, "     Method", "Enable method execution messages\n"},
302 	{1, "     Opcode", "Enable opcode execution messages\n"},
303 	{1, "  Tree", "Display control method calling tree\n"},
304 	{1, "  <Enter>", "Single step next AML opcode (over calls)\n"},
305 
306 #ifdef ACPI_APPLICATION
307 	{0, "\nHardware Simulation Commands:", "\n"},
308 	{1, "  EnableAcpi", "Enable ACPI (hardware) mode\n"},
309 	{1, "  Event <F|G> <Value>", "Generate AcpiEvent (Fixed/GPE)\n"},
310 	{1, "  Gpe <GpeNum> [GpeBlockDevice]", "Simulate a GPE\n"},
311 	{1, "  Gpes", "Display info on all GPE devices\n"},
312 	{1, "  Sci", "Generate an SCI\n"},
313 	{1, "  Sleep [SleepState]", "Simulate sleep/wake sequence(s) (0-5)\n"},
314 
315 	{0, "\nFile I/O Commands:", "\n"},
316 	{1, "  Close", "Close debug output file\n"},
317 	{1, "  Load <Input Filename>", "Load ACPI table from a file\n"},
318 	{1, "  Open <Output Filename>", "Open a file for debug output\n"},
319 	{1, "  Unload <Namepath>",
320 	 "Unload an ACPI table via namespace object\n"},
321 
322 	{0, "\nUser Space Commands:", "\n"},
323 	{1, "  Terminate", "Delete namespace and all internal objects\n"},
324 	{1, "  Thread <Threads><Loops><NamePath>",
325 	 "Spawn threads to execute method(s)\n"},
326 
327 	{0, "\nDebug Test Commands:", "\n"},
328 	{3, "  Test <TestName>", "Invoke a debug test\n"},
329 	{1, "     Objects", "Read/write/compare all namespace data objects\n"},
330 	{1, "     Predefined",
331 	 "Execute all ACPI predefined names (_STA, etc.)\n"},
332 #endif
333 	{0, NULL, NULL}
334 };
335 
336 /*******************************************************************************
337  *
338  * FUNCTION:    acpi_db_match_command_help
339  *
340  * PARAMETERS:  command             - Command string to match
341  *              help                - Help table entry to attempt match
342  *
343  * RETURN:      TRUE if command matched, FALSE otherwise
344  *
345  * DESCRIPTION: Attempt to match a command in the help table in order to
346  *              print help information for a single command.
347  *
348  ******************************************************************************/
349 
350 static u8
351 acpi_db_match_command_help(char *command,
352 			   const struct acpi_db_command_help *help)
353 {
354 	char *invocation = help->invocation;
355 	u32 line_count;
356 
357 	/* Valid commands in the help table begin with a couple of spaces */
358 
359 	if (*invocation != ' ') {
360 		return (FALSE);
361 	}
362 
363 	while (*invocation == ' ') {
364 		invocation++;
365 	}
366 
367 	/* Match command name (full command or substring) */
368 
369 	while ((*command) && (*invocation) && (*invocation != ' ')) {
370 		if (tolower((int)*command) != tolower((int)*invocation)) {
371 			return (FALSE);
372 		}
373 
374 		invocation++;
375 		command++;
376 	}
377 
378 	/* Print the appropriate number of help lines */
379 
380 	line_count = help->line_count;
381 	while (line_count) {
382 		acpi_os_printf("%-38s : %s", help->invocation,
383 			       help->description);
384 		help++;
385 		line_count--;
386 	}
387 
388 	return (TRUE);
389 }
390 
391 /*******************************************************************************
392  *
393  * FUNCTION:    acpi_db_display_command_info
394  *
395  * PARAMETERS:  command             - Command string to match
396  *              display_all         - Display all matching commands, or just
397  *                                    the first one (substring match)
398  *
399  * RETURN:      None
400  *
401  * DESCRIPTION: Display help information for a Debugger command.
402  *
403  ******************************************************************************/
404 
405 static void acpi_db_display_command_info(char *command, u8 display_all)
406 {
407 	const struct acpi_db_command_help *next;
408 	u8 matched;
409 
410 	next = acpi_gbl_db_command_help;
411 	while (next->invocation) {
412 		matched = acpi_db_match_command_help(command, next);
413 		if (!display_all && matched) {
414 			return;
415 		}
416 
417 		next++;
418 	}
419 }
420 
421 /*******************************************************************************
422  *
423  * FUNCTION:    acpi_db_display_help
424  *
425  * PARAMETERS:  command             - Optional command string to display help.
426  *                                    if not specified, all debugger command
427  *                                    help strings are displayed
428  *
429  * RETURN:      None
430  *
431  * DESCRIPTION: Display help for a single debugger command, or all of them.
432  *
433  ******************************************************************************/
434 
435 static void acpi_db_display_help(char *command)
436 {
437 	const struct acpi_db_command_help *next = acpi_gbl_db_command_help;
438 
439 	if (!command) {
440 
441 		/* No argument to help, display help for all commands */
442 
443 		while (next->invocation) {
444 			acpi_os_printf("%-38s%s", next->invocation,
445 				       next->description);
446 			next++;
447 		}
448 	} else {
449 		/* Display help for all commands that match the subtring */
450 
451 		acpi_db_display_command_info(command, TRUE);
452 	}
453 }
454 
455 /*******************************************************************************
456  *
457  * FUNCTION:    acpi_db_get_next_token
458  *
459  * PARAMETERS:  string          - Command buffer
460  *              next            - Return value, end of next token
461  *
462  * RETURN:      Pointer to the start of the next token.
463  *
464  * DESCRIPTION: Command line parsing. Get the next token on the command line
465  *
466  ******************************************************************************/
467 
468 char *acpi_db_get_next_token(char *string,
469 			     char **next, acpi_object_type * return_type)
470 {
471 	char *start;
472 	u32 depth;
473 	acpi_object_type type = ACPI_TYPE_INTEGER;
474 
475 	/* At end of buffer? */
476 
477 	if (!string || !(*string)) {
478 		return (NULL);
479 	}
480 
481 	/* Remove any spaces at the beginning */
482 
483 	if (*string == ' ') {
484 		while (*string && (*string == ' ')) {
485 			string++;
486 		}
487 
488 		if (!(*string)) {
489 			return (NULL);
490 		}
491 	}
492 
493 	switch (*string) {
494 	case '"':
495 
496 		/* This is a quoted string, scan until closing quote */
497 
498 		string++;
499 		start = string;
500 		type = ACPI_TYPE_STRING;
501 
502 		/* Find end of string */
503 
504 		while (*string && (*string != '"')) {
505 			string++;
506 		}
507 		break;
508 
509 	case '(':
510 
511 		/* This is the start of a buffer, scan until closing paren */
512 
513 		string++;
514 		start = string;
515 		type = ACPI_TYPE_BUFFER;
516 
517 		/* Find end of buffer */
518 
519 		while (*string && (*string != ')')) {
520 			string++;
521 		}
522 		break;
523 
524 	case '[':
525 
526 		/* This is the start of a package, scan until closing bracket */
527 
528 		string++;
529 		depth = 1;
530 		start = string;
531 		type = ACPI_TYPE_PACKAGE;
532 
533 		/* Find end of package (closing bracket) */
534 
535 		while (*string) {
536 
537 			/* Handle String package elements */
538 
539 			if (*string == '"') {
540 				/* Find end of string */
541 
542 				string++;
543 				while (*string && (*string != '"')) {
544 					string++;
545 				}
546 				if (!(*string)) {
547 					break;
548 				}
549 			} else if (*string == '[') {
550 				depth++;	/* A nested package declaration */
551 			} else if (*string == ']') {
552 				depth--;
553 				if (depth == 0) {	/* Found final package closing bracket */
554 					break;
555 				}
556 			}
557 
558 			string++;
559 		}
560 		break;
561 
562 	default:
563 
564 		start = string;
565 
566 		/* Find end of token */
567 
568 		while (*string && (*string != ' ')) {
569 			string++;
570 		}
571 		break;
572 	}
573 
574 	if (!(*string)) {
575 		*next = NULL;
576 	} else {
577 		*string = 0;
578 		*next = string + 1;
579 	}
580 
581 	*return_type = type;
582 	return (start);
583 }
584 
585 /*******************************************************************************
586  *
587  * FUNCTION:    acpi_db_get_line
588  *
589  * PARAMETERS:  input_buffer        - Command line buffer
590  *
591  * RETURN:      Count of arguments to the command
592  *
593  * DESCRIPTION: Get the next command line from the user. Gets entire line
594  *              up to the next newline
595  *
596  ******************************************************************************/
597 
598 static u32 acpi_db_get_line(char *input_buffer)
599 {
600 	u32 i;
601 	u32 count;
602 	char *next;
603 	char *this;
604 
605 	if (acpi_ut_safe_strcpy
606 	    (acpi_gbl_db_parsed_buf, sizeof(acpi_gbl_db_parsed_buf),
607 	     input_buffer)) {
608 		acpi_os_printf
609 		    ("Buffer overflow while parsing input line (max %u characters)\n",
610 		     sizeof(acpi_gbl_db_parsed_buf));
611 		return (0);
612 	}
613 
614 	this = acpi_gbl_db_parsed_buf;
615 	for (i = 0; i < ACPI_DEBUGGER_MAX_ARGS; i++) {
616 		acpi_gbl_db_args[i] = acpi_db_get_next_token(this, &next,
617 							     &acpi_gbl_db_arg_types
618 							     [i]);
619 		if (!acpi_gbl_db_args[i]) {
620 			break;
621 		}
622 
623 		this = next;
624 	}
625 
626 	/* Uppercase the actual command */
627 
628 	acpi_ut_strupr(acpi_gbl_db_args[0]);
629 
630 	count = i;
631 	if (count) {
632 		count--;	/* Number of args only */
633 	}
634 
635 	return (count);
636 }
637 
638 /*******************************************************************************
639  *
640  * FUNCTION:    acpi_db_match_command
641  *
642  * PARAMETERS:  user_command            - User command line
643  *
644  * RETURN:      Index into command array, -1 if not found
645  *
646  * DESCRIPTION: Search command array for a command match
647  *
648  ******************************************************************************/
649 
650 static u32 acpi_db_match_command(char *user_command)
651 {
652 	u32 i;
653 
654 	if (!user_command || user_command[0] == 0) {
655 		return (CMD_NULL);
656 	}
657 
658 	for (i = CMD_FIRST_VALID; acpi_gbl_db_commands[i].name; i++) {
659 		if (strstr(acpi_gbl_db_commands[i].name, user_command) ==
660 		    acpi_gbl_db_commands[i].name) {
661 			return (i);
662 		}
663 	}
664 
665 	/* Command not recognized */
666 
667 	return (CMD_NOT_FOUND);
668 }
669 
670 /*******************************************************************************
671  *
672  * FUNCTION:    acpi_db_command_dispatch
673  *
674  * PARAMETERS:  input_buffer        - Command line buffer
675  *              walk_state          - Current walk
676  *              op                  - Current (executing) parse op
677  *
678  * RETURN:      Status
679  *
680  * DESCRIPTION: Command dispatcher.
681  *
682  ******************************************************************************/
683 
684 acpi_status
685 acpi_db_command_dispatch(char *input_buffer,
686 			 struct acpi_walk_state * walk_state,
687 			 union acpi_parse_object * op)
688 {
689 	u32 temp;
690 	u32 command_index;
691 	u32 param_count;
692 	char *command_line;
693 	acpi_status status = AE_CTRL_TRUE;
694 
695 	/* If acpi_terminate has been called, terminate this thread */
696 
697 	if (acpi_gbl_db_terminate_loop) {
698 		return (AE_CTRL_TERMINATE);
699 	}
700 
701 	/* Find command and add to the history buffer */
702 
703 	param_count = acpi_db_get_line(input_buffer);
704 	command_index = acpi_db_match_command(acpi_gbl_db_args[0]);
705 	temp = 0;
706 
707 	/*
708 	 * We don't want to add the !! command to the history buffer. It
709 	 * would cause an infinite loop because it would always be the
710 	 * previous command.
711 	 */
712 	if (command_index != CMD_HISTORY_LAST) {
713 		acpi_db_add_to_history(input_buffer);
714 	}
715 
716 	/* Verify that we have the minimum number of params */
717 
718 	if (param_count < acpi_gbl_db_commands[command_index].min_args) {
719 		acpi_os_printf
720 		    ("%u parameters entered, [%s] requires %u parameters\n",
721 		     param_count, acpi_gbl_db_commands[command_index].name,
722 		     acpi_gbl_db_commands[command_index].min_args);
723 
724 		acpi_db_display_command_info(acpi_gbl_db_commands
725 					     [command_index].name, FALSE);
726 		return (AE_CTRL_TRUE);
727 	}
728 
729 	/* Decode and dispatch the command */
730 
731 	switch (command_index) {
732 	case CMD_NULL:
733 
734 		if (op) {
735 			return (AE_OK);
736 		}
737 		break;
738 
739 	case CMD_ALLOCATIONS:
740 
741 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
742 		acpi_ut_dump_allocations((u32)-1, NULL);
743 #endif
744 		break;
745 
746 	case CMD_ARGS:
747 	case CMD_ARGUMENTS:
748 
749 		acpi_db_display_arguments();
750 		break;
751 
752 	case CMD_BREAKPOINT:
753 
754 		acpi_db_set_method_breakpoint(acpi_gbl_db_args[1], walk_state,
755 					      op);
756 		break;
757 
758 	case CMD_BUSINFO:
759 
760 		acpi_db_get_bus_info();
761 		break;
762 
763 	case CMD_CALL:
764 
765 		acpi_db_set_method_call_breakpoint(op);
766 		status = AE_OK;
767 		break;
768 
769 	case CMD_DEBUG:
770 
771 		acpi_db_execute(acpi_gbl_db_args[1],
772 				&acpi_gbl_db_args[2], &acpi_gbl_db_arg_types[2],
773 				EX_SINGLE_STEP);
774 		break;
775 
776 	case CMD_DISASSEMBLE:
777 	case CMD_DISASM:
778 
779 		(void)acpi_db_disassemble_method(acpi_gbl_db_args[1]);
780 		break;
781 
782 	case CMD_DUMP:
783 
784 		acpi_db_decode_and_display_object(acpi_gbl_db_args[1],
785 						  acpi_gbl_db_args[2]);
786 		break;
787 
788 	case CMD_EVALUATE:
789 	case CMD_EXECUTE:
790 
791 		acpi_db_execute(acpi_gbl_db_args[1],
792 				&acpi_gbl_db_args[2], &acpi_gbl_db_arg_types[2],
793 				EX_NO_SINGLE_STEP);
794 		break;
795 
796 	case CMD_FIND:
797 
798 		status = acpi_db_find_name_in_namespace(acpi_gbl_db_args[1]);
799 		break;
800 
801 	case CMD_GO:
802 
803 		acpi_gbl_cm_single_step = FALSE;
804 		return (AE_OK);
805 
806 	case CMD_HANDLERS:
807 
808 		acpi_db_display_handlers();
809 		break;
810 
811 	case CMD_HELP:
812 	case CMD_HELP2:
813 
814 		acpi_db_display_help(acpi_gbl_db_args[1]);
815 		break;
816 
817 	case CMD_HISTORY:
818 
819 		acpi_db_display_history();
820 		break;
821 
822 	case CMD_HISTORY_EXE:	/* ! command */
823 
824 		command_line = acpi_db_get_from_history(acpi_gbl_db_args[1]);
825 		if (!command_line) {
826 			return (AE_CTRL_TRUE);
827 		}
828 
829 		status = acpi_db_command_dispatch(command_line, walk_state, op);
830 		return (status);
831 
832 	case CMD_HISTORY_LAST:	/* !! command */
833 
834 		command_line = acpi_db_get_from_history(NULL);
835 		if (!command_line) {
836 			return (AE_CTRL_TRUE);
837 		}
838 
839 		status = acpi_db_command_dispatch(command_line, walk_state, op);
840 		return (status);
841 
842 	case CMD_INFORMATION:
843 
844 		acpi_db_display_method_info(op);
845 		break;
846 
847 	case CMD_INTEGRITY:
848 
849 		acpi_db_check_integrity();
850 		break;
851 
852 	case CMD_INTO:
853 
854 		if (op) {
855 			acpi_gbl_cm_single_step = TRUE;
856 			return (AE_OK);
857 		}
858 		break;
859 
860 	case CMD_LEVEL:
861 
862 		if (param_count == 0) {
863 			acpi_os_printf
864 			    ("Current debug level for file output is:    %8.8lX\n",
865 			     acpi_gbl_db_debug_level);
866 			acpi_os_printf
867 			    ("Current debug level for console output is: %8.8lX\n",
868 			     acpi_gbl_db_console_debug_level);
869 		} else if (param_count == 2) {
870 			temp = acpi_gbl_db_console_debug_level;
871 			acpi_gbl_db_console_debug_level =
872 			    strtoul(acpi_gbl_db_args[1], NULL, 16);
873 			acpi_os_printf
874 			    ("Debug Level for console output was %8.8lX, now %8.8lX\n",
875 			     temp, acpi_gbl_db_console_debug_level);
876 		} else {
877 			temp = acpi_gbl_db_debug_level;
878 			acpi_gbl_db_debug_level =
879 			    strtoul(acpi_gbl_db_args[1], NULL, 16);
880 			acpi_os_printf
881 			    ("Debug Level for file output was %8.8lX, now %8.8lX\n",
882 			     temp, acpi_gbl_db_debug_level);
883 		}
884 		break;
885 
886 	case CMD_LIST:
887 
888 		acpi_db_disassemble_aml(acpi_gbl_db_args[1], op);
889 		break;
890 
891 	case CMD_LOCKS:
892 
893 		acpi_db_display_locks();
894 		break;
895 
896 	case CMD_LOCALS:
897 
898 		acpi_db_display_locals();
899 		break;
900 
901 	case CMD_METHODS:
902 
903 		status = acpi_db_display_objects("METHOD", acpi_gbl_db_args[1]);
904 		break;
905 
906 	case CMD_NAMESPACE:
907 
908 		acpi_db_dump_namespace(acpi_gbl_db_args[1],
909 				       acpi_gbl_db_args[2]);
910 		break;
911 
912 	case CMD_NOTIFY:
913 
914 		temp = strtoul(acpi_gbl_db_args[2], NULL, 0);
915 		acpi_db_send_notify(acpi_gbl_db_args[1], temp);
916 		break;
917 
918 	case CMD_OBJECTS:
919 
920 		acpi_ut_strupr(acpi_gbl_db_args[1]);
921 		status =
922 		    acpi_db_display_objects(acpi_gbl_db_args[1],
923 					    acpi_gbl_db_args[2]);
924 		break;
925 
926 	case CMD_OSI:
927 
928 		acpi_db_display_interfaces(acpi_gbl_db_args[1],
929 					   acpi_gbl_db_args[2]);
930 		break;
931 
932 	case CMD_OWNER:
933 
934 		acpi_db_dump_namespace_by_owner(acpi_gbl_db_args[1],
935 						acpi_gbl_db_args[2]);
936 		break;
937 
938 	case CMD_PATHS:
939 
940 		acpi_db_dump_namespace_paths();
941 		break;
942 
943 	case CMD_PREFIX:
944 
945 		acpi_db_set_scope(acpi_gbl_db_args[1]);
946 		break;
947 
948 	case CMD_REFERENCES:
949 
950 		acpi_db_find_references(acpi_gbl_db_args[1]);
951 		break;
952 
953 	case CMD_RESOURCES:
954 
955 		acpi_db_display_resources(acpi_gbl_db_args[1]);
956 		break;
957 
958 	case CMD_RESULTS:
959 
960 		acpi_db_display_results();
961 		break;
962 
963 	case CMD_SET:
964 
965 		acpi_db_set_method_data(acpi_gbl_db_args[1],
966 					acpi_gbl_db_args[2],
967 					acpi_gbl_db_args[3]);
968 		break;
969 
970 	case CMD_STATS:
971 
972 		status = acpi_db_display_statistics(acpi_gbl_db_args[1]);
973 		break;
974 
975 	case CMD_STOP:
976 
977 		return (AE_NOT_IMPLEMENTED);
978 
979 	case CMD_TABLES:
980 
981 		acpi_db_display_table_info(acpi_gbl_db_args[1]);
982 		break;
983 
984 	case CMD_TEMPLATE:
985 
986 		acpi_db_display_template(acpi_gbl_db_args[1]);
987 		break;
988 
989 	case CMD_TRACE:
990 
991 		acpi_db_trace(acpi_gbl_db_args[1], acpi_gbl_db_args[2],
992 			      acpi_gbl_db_args[3]);
993 		break;
994 
995 	case CMD_TREE:
996 
997 		acpi_db_display_calling_tree();
998 		break;
999 
1000 	case CMD_TYPE:
1001 
1002 		acpi_db_display_object_type(acpi_gbl_db_args[1]);
1003 		break;
1004 
1005 #ifdef ACPI_APPLICATION
1006 
1007 		/* Hardware simulation commands. */
1008 
1009 	case CMD_ENABLEACPI:
1010 #if (!ACPI_REDUCED_HARDWARE)
1011 
1012 		status = acpi_enable();
1013 		if (ACPI_FAILURE(status)) {
1014 			acpi_os_printf("AcpiEnable failed (Status=%X)\n",
1015 				       status);
1016 			return (status);
1017 		}
1018 #endif				/* !ACPI_REDUCED_HARDWARE */
1019 		break;
1020 
1021 	case CMD_EVENT:
1022 
1023 		acpi_os_printf("Event command not implemented\n");
1024 		break;
1025 
1026 	case CMD_GPE:
1027 
1028 		acpi_db_generate_gpe(acpi_gbl_db_args[1], acpi_gbl_db_args[2]);
1029 		break;
1030 
1031 	case CMD_GPES:
1032 
1033 		acpi_db_display_gpes();
1034 		break;
1035 
1036 	case CMD_SCI:
1037 
1038 		acpi_db_generate_sci();
1039 		break;
1040 
1041 	case CMD_SLEEP:
1042 
1043 		status = acpi_db_sleep(acpi_gbl_db_args[1]);
1044 		break;
1045 
1046 		/* File I/O commands. */
1047 
1048 	case CMD_CLOSE:
1049 
1050 		acpi_db_close_debug_file();
1051 		break;
1052 
1053 	case CMD_LOAD:{
1054 			struct acpi_new_table_desc *list_head = NULL;
1055 
1056 			status =
1057 			    ac_get_all_tables_from_file(acpi_gbl_db_args[1],
1058 							ACPI_GET_ALL_TABLES,
1059 							&list_head);
1060 			if (ACPI_SUCCESS(status)) {
1061 				acpi_db_load_tables(list_head);
1062 			}
1063 		}
1064 		break;
1065 
1066 	case CMD_OPEN:
1067 
1068 		acpi_db_open_debug_file(acpi_gbl_db_args[1]);
1069 		break;
1070 
1071 		/* User space commands. */
1072 
1073 	case CMD_TERMINATE:
1074 
1075 		acpi_db_set_output_destination(ACPI_DB_REDIRECTABLE_OUTPUT);
1076 		acpi_ut_subsystem_shutdown();
1077 
1078 		/*
1079 		 * TBD: [Restructure] Need some way to re-initialize without
1080 		 * re-creating the semaphores!
1081 		 */
1082 
1083 		acpi_gbl_db_terminate_loop = TRUE;
1084 		/*  acpi_initialize (NULL); */
1085 		break;
1086 
1087 	case CMD_THREADS:
1088 
1089 		acpi_db_create_execution_threads(acpi_gbl_db_args[1],
1090 						 acpi_gbl_db_args[2],
1091 						 acpi_gbl_db_args[3]);
1092 		break;
1093 
1094 		/* Debug test commands. */
1095 
1096 	case CMD_PREDEFINED:
1097 
1098 		acpi_db_check_predefined_names();
1099 		break;
1100 
1101 	case CMD_TEST:
1102 
1103 		acpi_db_execute_test(acpi_gbl_db_args[1]);
1104 		break;
1105 
1106 	case CMD_UNLOAD:
1107 
1108 		acpi_db_unload_acpi_table(acpi_gbl_db_args[1]);
1109 		break;
1110 #endif
1111 
1112 	case CMD_EXIT:
1113 	case CMD_QUIT:
1114 
1115 		if (op) {
1116 			acpi_os_printf("Method execution terminated\n");
1117 			return (AE_CTRL_TERMINATE);
1118 		}
1119 
1120 		if (!acpi_gbl_db_output_to_file) {
1121 			acpi_dbg_level = ACPI_DEBUG_DEFAULT;
1122 		}
1123 #ifdef ACPI_APPLICATION
1124 		acpi_db_close_debug_file();
1125 #endif
1126 		acpi_gbl_db_terminate_loop = TRUE;
1127 		return (AE_CTRL_TERMINATE);
1128 
1129 	case CMD_NOT_FOUND:
1130 	default:
1131 
1132 		acpi_os_printf("%s: unknown command\n", acpi_gbl_db_args[0]);
1133 		return (AE_CTRL_TRUE);
1134 	}
1135 
1136 	if (ACPI_SUCCESS(status)) {
1137 		status = AE_CTRL_TRUE;
1138 	}
1139 
1140 	return (status);
1141 }
1142 
1143 /*******************************************************************************
1144  *
1145  * FUNCTION:    acpi_db_execute_thread
1146  *
1147  * PARAMETERS:  context         - Not used
1148  *
1149  * RETURN:      None
1150  *
1151  * DESCRIPTION: Debugger execute thread. Waits for a command line, then
1152  *              simply dispatches it.
1153  *
1154  ******************************************************************************/
1155 
1156 void ACPI_SYSTEM_XFACE acpi_db_execute_thread(void *context)
1157 {
1158 
1159 	(void)acpi_db_user_commands();
1160 	acpi_gbl_db_threads_terminated = TRUE;
1161 }
1162 
1163 /*******************************************************************************
1164  *
1165  * FUNCTION:    acpi_db_user_commands
1166  *
1167  * PARAMETERS:  None
1168  *
1169  * RETURN:      None
1170  *
1171  * DESCRIPTION: Command line execution for the AML debugger. Commands are
1172  *              matched and dispatched here.
1173  *
1174  ******************************************************************************/
1175 
1176 acpi_status acpi_db_user_commands(void)
1177 {
1178 	acpi_status status = AE_OK;
1179 
1180 	acpi_os_printf("\n");
1181 
1182 	/* TBD: [Restructure] Need a separate command line buffer for step mode */
1183 
1184 	while (!acpi_gbl_db_terminate_loop) {
1185 
1186 		/* Wait the readiness of the command */
1187 
1188 		status = acpi_os_wait_command_ready();
1189 		if (ACPI_FAILURE(status)) {
1190 			break;
1191 		}
1192 
1193 		/* Just call to the command line interpreter */
1194 
1195 		acpi_gbl_method_executing = FALSE;
1196 		acpi_gbl_step_to_next_call = FALSE;
1197 
1198 		(void)acpi_db_command_dispatch(acpi_gbl_db_line_buf, NULL,
1199 					       NULL);
1200 
1201 		/* Notify the completion of the command */
1202 
1203 		status = acpi_os_notify_command_complete();
1204 		if (ACPI_FAILURE(status)) {
1205 			break;
1206 		}
1207 	}
1208 
1209 	if (ACPI_FAILURE(status) && status != AE_CTRL_TERMINATE) {
1210 		ACPI_EXCEPTION((AE_INFO, status, "While parsing command line"));
1211 	}
1212 	return (status);
1213 }
1214