1 /*******************************************************************************
2 *
3 * Module Name: dbutils - AML debugger utilities
4 *
5 ******************************************************************************/
6
7 /******************************************************************************
8 *
9 * 1. Copyright Notice
10 *
11 * Some or all of this work - Copyright (c) 1999 - 2021, Intel Corp.
12 * All rights reserved.
13 *
14 * 2. License
15 *
16 * 2.1. This is your license from Intel Corp. under its intellectual property
17 * rights. You may have additional license terms from the party that provided
18 * you this software, covering your right to use that party's intellectual
19 * property rights.
20 *
21 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
22 * copy of the source code appearing in this file ("Covered Code") an
23 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
24 * base code distributed originally by Intel ("Original Intel Code") to copy,
25 * make derivatives, distribute, use and display any portion of the Covered
26 * Code in any form, with the right to sublicense such rights; and
27 *
28 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
29 * license (with the right to sublicense), under only those claims of Intel
30 * patents that are infringed by the Original Intel Code, to make, use, sell,
31 * offer to sell, and import the Covered Code and derivative works thereof
32 * solely to the minimum extent necessary to exercise the above copyright
33 * license, and in no event shall the patent license extend to any additions
34 * to or modifications of the Original Intel Code. No other license or right
35 * is granted directly or by implication, estoppel or otherwise;
36 *
37 * The above copyright and patent license is granted only if the following
38 * conditions are met:
39 *
40 * 3. Conditions
41 *
42 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
43 * Redistribution of source code of any substantial portion of the Covered
44 * Code or modification with rights to further distribute source must include
45 * the above Copyright Notice, the above License, this list of Conditions,
46 * and the following Disclaimer and Export Compliance provision. In addition,
47 * Licensee must cause all Covered Code to which Licensee contributes to
48 * contain a file documenting the changes Licensee made to create that Covered
49 * Code and the date of any change. Licensee must include in that file the
50 * documentation of any changes made by any predecessor Licensee. Licensee
51 * must include a prominent statement that the modification is derived,
52 * directly or indirectly, from Original Intel Code.
53 *
54 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
55 * Redistribution of source code of any substantial portion of the Covered
56 * Code or modification without rights to further distribute source must
57 * include the following Disclaimer and Export Compliance provision in the
58 * documentation and/or other materials provided with distribution. In
59 * addition, Licensee may not authorize further sublicense of source of any
60 * portion of the Covered Code, and must include terms to the effect that the
61 * license from Licensee to its licensee is limited to the intellectual
62 * property embodied in the software Licensee provides to its licensee, and
63 * not to intellectual property embodied in modifications its licensee may
64 * make.
65 *
66 * 3.3. Redistribution of Executable. Redistribution in executable form of any
67 * substantial portion of the Covered Code or modification must reproduce the
68 * above Copyright Notice, and the following Disclaimer and Export Compliance
69 * provision in the documentation and/or other materials provided with the
70 * distribution.
71 *
72 * 3.4. Intel retains all right, title, and interest in and to the Original
73 * Intel Code.
74 *
75 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
76 * Intel shall be used in advertising or otherwise to promote the sale, use or
77 * other dealings in products derived from or relating to the Covered Code
78 * without prior written authorization from Intel.
79 *
80 * 4. Disclaimer and Export Compliance
81 *
82 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
83 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
84 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
85 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
86 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
87 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
88 * PARTICULAR PURPOSE.
89 *
90 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
91 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
92 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
93 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
94 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
95 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
96 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
97 * LIMITED REMEDY.
98 *
99 * 4.3. Licensee shall not export, either directly or indirectly, any of this
100 * software or system incorporating such software without first obtaining any
101 * required license or other approval from the U. S. Department of Commerce or
102 * any other agency or department of the United States Government. In the
103 * event Licensee exports any such software from the United States or
104 * re-exports any such software from a foreign destination, Licensee shall
105 * ensure that the distribution and export/re-export of the software is in
106 * compliance with all laws, regulations, orders, or other restrictions of the
107 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
108 * any of its subsidiaries will export/re-export any technical data, process,
109 * software, or service, directly or indirectly, to any country for which the
110 * United States government or any agency thereof requires an export license,
111 * other governmental approval, or letter of assurance, without first obtaining
112 * such license, approval or letter.
113 *
114 *****************************************************************************
115 *
116 * Alternatively, you may choose to be licensed under the terms of the
117 * following license:
118 *
119 * Redistribution and use in source and binary forms, with or without
120 * modification, are permitted provided that the following conditions
121 * are met:
122 * 1. Redistributions of source code must retain the above copyright
123 * notice, this list of conditions, and the following disclaimer,
124 * without modification.
125 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
126 * substantially similar to the "NO WARRANTY" disclaimer below
127 * ("Disclaimer") and any redistribution must be conditioned upon
128 * including a substantially similar Disclaimer requirement for further
129 * binary redistribution.
130 * 3. Neither the names of the above-listed copyright holders nor the names
131 * of any contributors may be used to endorse or promote products derived
132 * from this software without specific prior written permission.
133 *
134 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
135 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
136 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
137 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
138 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
139 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
140 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
141 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
142 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
143 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
144 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
145 *
146 * Alternatively, you may choose to be licensed under the terms of the
147 * GNU General Public License ("GPL") version 2 as published by the Free
148 * Software Foundation.
149 *
150 *****************************************************************************/
151
152 #include "acpi.h"
153 #include "accommon.h"
154 #include "acnamesp.h"
155 #include "acdebug.h"
156
157
158 #ifdef ACPI_DEBUGGER
159
160 #define _COMPONENT ACPI_CA_DEBUGGER
161 ACPI_MODULE_NAME ("dbutils")
162
163
164 /* Local prototypes */
165
166 #ifdef ACPI_OBSOLETE_FUNCTIONS
167 ACPI_STATUS
168 AcpiDbSecondPassParse (
169 ACPI_PARSE_OBJECT *Root);
170
171 void
172 AcpiDbDumpBuffer (
173 UINT32 Address);
174 #endif
175
176
177 /*******************************************************************************
178 *
179 * FUNCTION: AcpiDbMatchArgument
180 *
181 * PARAMETERS: UserArgument - User command line
182 * Arguments - Array of commands to match against
183 *
184 * RETURN: Index into command array or ACPI_TYPE_NOT_FOUND if not found
185 *
186 * DESCRIPTION: Search command array for a command match
187 *
188 ******************************************************************************/
189
190 ACPI_OBJECT_TYPE
AcpiDbMatchArgument(char * UserArgument,ACPI_DB_ARGUMENT_INFO * Arguments)191 AcpiDbMatchArgument (
192 char *UserArgument,
193 ACPI_DB_ARGUMENT_INFO *Arguments)
194 {
195 UINT32 i;
196
197
198 if (!UserArgument || UserArgument[0] == 0)
199 {
200 return (ACPI_TYPE_NOT_FOUND);
201 }
202
203 for (i = 0; Arguments[i].Name; i++)
204 {
205 if (strstr (
206 ACPI_CAST_PTR (char, Arguments[i].Name),
207 ACPI_CAST_PTR (char, UserArgument)) == Arguments[i].Name)
208 {
209 return (i);
210 }
211 }
212
213 /* Argument not recognized */
214
215 return (ACPI_TYPE_NOT_FOUND);
216 }
217
218
219 /*******************************************************************************
220 *
221 * FUNCTION: AcpiDbSetOutputDestination
222 *
223 * PARAMETERS: OutputFlags - Current flags word
224 *
225 * RETURN: None
226 *
227 * DESCRIPTION: Set the current destination for debugger output. Also sets
228 * the debug output level accordingly.
229 *
230 ******************************************************************************/
231
232 void
AcpiDbSetOutputDestination(UINT32 OutputFlags)233 AcpiDbSetOutputDestination (
234 UINT32 OutputFlags)
235 {
236
237 AcpiGbl_DbOutputFlags = (UINT8) OutputFlags;
238
239 if ((OutputFlags & ACPI_DB_REDIRECTABLE_OUTPUT) &&
240 AcpiGbl_DbOutputToFile)
241 {
242 AcpiDbgLevel = AcpiGbl_DbDebugLevel;
243 }
244 else
245 {
246 AcpiDbgLevel = AcpiGbl_DbConsoleDebugLevel;
247 }
248 }
249
250
251 /*******************************************************************************
252 *
253 * FUNCTION: AcpiDbDumpExternalObject
254 *
255 * PARAMETERS: ObjDesc - External ACPI object to dump
256 * Level - Nesting level.
257 *
258 * RETURN: None
259 *
260 * DESCRIPTION: Dump the contents of an ACPI external object
261 *
262 ******************************************************************************/
263
264 void
AcpiDbDumpExternalObject(ACPI_OBJECT * ObjDesc,UINT32 Level)265 AcpiDbDumpExternalObject (
266 ACPI_OBJECT *ObjDesc,
267 UINT32 Level)
268 {
269 UINT32 i;
270
271
272 if (!ObjDesc)
273 {
274 AcpiOsPrintf ("[Null Object]\n");
275 return;
276 }
277
278 for (i = 0; i < Level; i++)
279 {
280 AcpiOsPrintf (" ");
281 }
282
283 switch (ObjDesc->Type)
284 {
285 case ACPI_TYPE_ANY:
286
287 AcpiOsPrintf ("[Null Object] (Type=0)\n");
288 break;
289
290 case ACPI_TYPE_INTEGER:
291
292 AcpiOsPrintf ("[Integer] = %8.8X%8.8X\n",
293 ACPI_FORMAT_UINT64 (ObjDesc->Integer.Value));
294 break;
295
296 case ACPI_TYPE_STRING:
297
298 AcpiOsPrintf ("[String] Length %.2X = ", ObjDesc->String.Length);
299 AcpiUtPrintString (ObjDesc->String.Pointer, ACPI_UINT8_MAX);
300 AcpiOsPrintf ("\n");
301 break;
302
303 case ACPI_TYPE_BUFFER:
304
305 AcpiOsPrintf ("[Buffer] Length %.2X = ", ObjDesc->Buffer.Length);
306 if (ObjDesc->Buffer.Length)
307 {
308 if (ObjDesc->Buffer.Length > 16)
309 {
310 AcpiOsPrintf ("\n");
311 }
312
313 AcpiUtDebugDumpBuffer (
314 ACPI_CAST_PTR (UINT8, ObjDesc->Buffer.Pointer),
315 ObjDesc->Buffer.Length, DB_BYTE_DISPLAY, _COMPONENT);
316 }
317 else
318 {
319 AcpiOsPrintf ("\n");
320 }
321 break;
322
323 case ACPI_TYPE_PACKAGE:
324
325 AcpiOsPrintf ("[Package] Contains %u Elements:\n",
326 ObjDesc->Package.Count);
327
328 for (i = 0; i < ObjDesc->Package.Count; i++)
329 {
330 AcpiDbDumpExternalObject (
331 &ObjDesc->Package.Elements[i], Level+1);
332 }
333 break;
334
335 case ACPI_TYPE_LOCAL_REFERENCE:
336
337 AcpiOsPrintf ("[Object Reference] = ");
338 AcpiDbDisplayInternalObject (ObjDesc->Reference.Handle, NULL);
339 break;
340
341 case ACPI_TYPE_PROCESSOR:
342
343 AcpiOsPrintf ("[Processor]\n");
344 break;
345
346 case ACPI_TYPE_POWER:
347
348 AcpiOsPrintf ("[Power Resource]\n");
349 break;
350
351 default:
352
353 AcpiOsPrintf ("[Unknown Type] %X\n", ObjDesc->Type);
354 break;
355 }
356 }
357
358
359 /*******************************************************************************
360 *
361 * FUNCTION: AcpiDbPrepNamestring
362 *
363 * PARAMETERS: Name - String to prepare
364 *
365 * RETURN: None
366 *
367 * DESCRIPTION: Translate all forward slashes and dots to backslashes.
368 *
369 ******************************************************************************/
370
371 void
AcpiDbPrepNamestring(char * Name)372 AcpiDbPrepNamestring (
373 char *Name)
374 {
375
376 if (!Name)
377 {
378 return;
379 }
380
381 AcpiUtStrupr (Name);
382
383 /* Convert a leading forward slash to a backslash */
384
385 if (*Name == '/')
386 {
387 *Name = '\\';
388 }
389
390 /* Ignore a leading backslash, this is the root prefix */
391
392 if (ACPI_IS_ROOT_PREFIX (*Name))
393 {
394 Name++;
395 }
396
397 /* Convert all slash path separators to dots */
398
399 while (*Name)
400 {
401 if ((*Name == '/') ||
402 (*Name == '\\'))
403 {
404 *Name = '.';
405 }
406
407 Name++;
408 }
409 }
410
411
412 /*******************************************************************************
413 *
414 * FUNCTION: AcpiDbLocalNsLookup
415 *
416 * PARAMETERS: Name - Name to lookup
417 *
418 * RETURN: Pointer to a namespace node, null on failure
419 *
420 * DESCRIPTION: Lookup a name in the ACPI namespace
421 *
422 * Note: Currently begins search from the root. Could be enhanced to use
423 * the current prefix (scope) node as the search beginning point.
424 *
425 ******************************************************************************/
426
427 ACPI_NAMESPACE_NODE *
AcpiDbLocalNsLookup(char * Name)428 AcpiDbLocalNsLookup (
429 char *Name)
430 {
431 char *InternalPath;
432 ACPI_STATUS Status;
433 ACPI_NAMESPACE_NODE *Node = NULL;
434
435
436 AcpiDbPrepNamestring (Name);
437
438 /* Build an internal namestring */
439
440 Status = AcpiNsInternalizeName (Name, &InternalPath);
441 if (ACPI_FAILURE (Status))
442 {
443 AcpiOsPrintf ("Invalid namestring: %s\n", Name);
444 return (NULL);
445 }
446
447 /*
448 * Lookup the name.
449 * (Uses root node as the search starting point)
450 */
451 Status = AcpiNsLookup (NULL, InternalPath, ACPI_TYPE_ANY,
452 ACPI_IMODE_EXECUTE, ACPI_NS_NO_UPSEARCH | ACPI_NS_DONT_OPEN_SCOPE,
453 NULL, &Node);
454 if (ACPI_FAILURE (Status))
455 {
456 AcpiOsPrintf ("Could not locate name: %s, %s\n",
457 Name, AcpiFormatException (Status));
458 }
459
460 ACPI_FREE (InternalPath);
461 return (Node);
462 }
463
464
465 /*******************************************************************************
466 *
467 * FUNCTION: AcpiDbUint32ToHexString
468 *
469 * PARAMETERS: Value - The value to be converted to string
470 * Buffer - Buffer for result (not less than 11 bytes)
471 *
472 * RETURN: None
473 *
474 * DESCRIPTION: Convert the unsigned 32-bit value to the hexadecimal image
475 *
476 * NOTE: It is the caller's responsibility to ensure that the length of buffer
477 * is sufficient.
478 *
479 ******************************************************************************/
480
481 void
AcpiDbUint32ToHexString(UINT32 Value,char * Buffer)482 AcpiDbUint32ToHexString (
483 UINT32 Value,
484 char *Buffer)
485 {
486 int i;
487
488
489 if (Value == 0)
490 {
491 strcpy (Buffer, "0");
492 return;
493 }
494
495 Buffer[8] = '\0';
496
497 for (i = 7; i >= 0; i--)
498 {
499 Buffer[i] = AcpiGbl_UpperHexDigits [Value & 0x0F];
500 Value = Value >> 4;
501 }
502 }
503
504
505 #ifdef ACPI_OBSOLETE_FUNCTIONS
506 /*******************************************************************************
507 *
508 * FUNCTION: AcpiDbSecondPassParse
509 *
510 * PARAMETERS: Root - Root of the parse tree
511 *
512 * RETURN: Status
513 *
514 * DESCRIPTION: Second pass parse of the ACPI tables. We need to wait until
515 * second pass to parse the control methods
516 *
517 ******************************************************************************/
518
519 ACPI_STATUS
AcpiDbSecondPassParse(ACPI_PARSE_OBJECT * Root)520 AcpiDbSecondPassParse (
521 ACPI_PARSE_OBJECT *Root)
522 {
523 ACPI_PARSE_OBJECT *Op = Root;
524 ACPI_PARSE_OBJECT *Method;
525 ACPI_PARSE_OBJECT *SearchOp;
526 ACPI_PARSE_OBJECT *StartOp;
527 ACPI_STATUS Status = AE_OK;
528 UINT32 BaseAmlOffset;
529 ACPI_WALK_STATE *WalkState;
530
531
532 ACPI_FUNCTION_ENTRY ();
533
534
535 AcpiOsPrintf ("Pass two parse ....\n");
536
537 while (Op)
538 {
539 if (Op->Common.AmlOpcode == AML_METHOD_OP)
540 {
541 Method = Op;
542
543 /* Create a new walk state for the parse */
544
545 WalkState = AcpiDsCreateWalkState (0, NULL, NULL, NULL);
546 if (!WalkState)
547 {
548 return (AE_NO_MEMORY);
549 }
550
551 /* Init the Walk State */
552
553 WalkState->ParserState.Aml =
554 WalkState->ParserState.AmlStart = Method->Named.Data;
555 WalkState->ParserState.AmlEnd =
556 WalkState->ParserState.PkgEnd = Method->Named.Data +
557 Method->Named.Length;
558 WalkState->ParserState.StartScope = Op;
559
560 WalkState->DescendingCallback = AcpiDsLoad1BeginOp;
561 WalkState->AscendingCallback = AcpiDsLoad1EndOp;
562
563 /* Perform the AML parse */
564
565 Status = AcpiPsParseAml (WalkState);
566
567 BaseAmlOffset = (Method->Common.Value.Arg)->Common.AmlOffset + 1;
568 StartOp = (Method->Common.Value.Arg)->Common.Next;
569 SearchOp = StartOp;
570
571 while (SearchOp)
572 {
573 SearchOp->Common.AmlOffset += BaseAmlOffset;
574 SearchOp = AcpiPsGetDepthNext (StartOp, SearchOp);
575 }
576 }
577
578 if (Op->Common.AmlOpcode == AML_REGION_OP)
579 {
580 /* TBD: [Investigate] this isn't quite the right thing to do! */
581 /*
582 *
583 * Method = (ACPI_DEFERRED_OP *) Op;
584 * Status = AcpiPsParseAml (Op, Method->Body, Method->BodyLength);
585 */
586 }
587
588 if (ACPI_FAILURE (Status))
589 {
590 break;
591 }
592
593 Op = AcpiPsGetDepthNext (Root, Op);
594 }
595
596 return (Status);
597 }
598
599
600 /*******************************************************************************
601 *
602 * FUNCTION: AcpiDbDumpBuffer
603 *
604 * PARAMETERS: Address - Pointer to the buffer
605 *
606 * RETURN: None
607 *
608 * DESCRIPTION: Print a portion of a buffer
609 *
610 ******************************************************************************/
611
612 void
AcpiDbDumpBuffer(UINT32 Address)613 AcpiDbDumpBuffer (
614 UINT32 Address)
615 {
616
617 AcpiOsPrintf ("\nLocation %X:\n", Address);
618
619 AcpiDbgLevel |= ACPI_LV_TABLES;
620 AcpiUtDebugDumpBuffer (ACPI_TO_POINTER (Address), 64, DB_BYTE_DISPLAY,
621 ACPI_UINT32_MAX);
622 }
623 #endif
624
625 #endif /* ACPI_DEBUGGER */
626