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 - 2023, 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 #define _COMPONENT ACPI_CA_DEBUGGER
159 ACPI_MODULE_NAME ("dbutils")
160
161
162 /* Local prototypes */
163
164 #ifdef ACPI_OBSOLETE_FUNCTIONS
165 ACPI_STATUS
166 AcpiDbSecondPassParse (
167 ACPI_PARSE_OBJECT *Root);
168
169 void
170 AcpiDbDumpBuffer (
171 UINT32 Address);
172 #endif
173
174
175 /*******************************************************************************
176 *
177 * FUNCTION: AcpiDbMatchArgument
178 *
179 * PARAMETERS: UserArgument - User command line
180 * Arguments - Array of commands to match against
181 *
182 * RETURN: Index into command array or ACPI_TYPE_NOT_FOUND if not found
183 *
184 * DESCRIPTION: Search command array for a command match
185 *
186 ******************************************************************************/
187
188 ACPI_OBJECT_TYPE
AcpiDbMatchArgument(char * UserArgument,ACPI_DB_ARGUMENT_INFO * Arguments)189 AcpiDbMatchArgument (
190 char *UserArgument,
191 ACPI_DB_ARGUMENT_INFO *Arguments)
192 {
193 UINT32 i;
194
195
196 if (!UserArgument || UserArgument[0] == 0)
197 {
198 return (ACPI_TYPE_NOT_FOUND);
199 }
200
201 for (i = 0; Arguments[i].Name; i++)
202 {
203 if (strstr (
204 ACPI_CAST_PTR (char, Arguments[i].Name),
205 ACPI_CAST_PTR (char, UserArgument)) == Arguments[i].Name)
206 {
207 return (i);
208 }
209 }
210
211 /* Argument not recognized */
212
213 return (ACPI_TYPE_NOT_FOUND);
214 }
215
216
217 /*******************************************************************************
218 *
219 * FUNCTION: AcpiDbSetOutputDestination
220 *
221 * PARAMETERS: OutputFlags - Current flags word
222 *
223 * RETURN: None
224 *
225 * DESCRIPTION: Set the current destination for debugger output. Also sets
226 * the debug output level accordingly.
227 *
228 ******************************************************************************/
229
230 void
AcpiDbSetOutputDestination(UINT32 OutputFlags)231 AcpiDbSetOutputDestination (
232 UINT32 OutputFlags)
233 {
234
235 AcpiGbl_DbOutputFlags = (UINT8) OutputFlags;
236
237 if ((OutputFlags & ACPI_DB_REDIRECTABLE_OUTPUT) &&
238 AcpiGbl_DbOutputToFile)
239 {
240 AcpiDbgLevel = AcpiGbl_DbDebugLevel;
241 }
242 else
243 {
244 AcpiDbgLevel = AcpiGbl_DbConsoleDebugLevel;
245 }
246 }
247
248
249 /*******************************************************************************
250 *
251 * FUNCTION: AcpiDbDumpExternalObject
252 *
253 * PARAMETERS: ObjDesc - External ACPI object to dump
254 * Level - Nesting level.
255 *
256 * RETURN: None
257 *
258 * DESCRIPTION: Dump the contents of an ACPI external object
259 *
260 ******************************************************************************/
261
262 void
AcpiDbDumpExternalObject(ACPI_OBJECT * ObjDesc,UINT32 Level)263 AcpiDbDumpExternalObject (
264 ACPI_OBJECT *ObjDesc,
265 UINT32 Level)
266 {
267 UINT32 i;
268
269
270 if (!ObjDesc)
271 {
272 AcpiOsPrintf ("[Null Object]\n");
273 return;
274 }
275
276 for (i = 0; i < Level; i++)
277 {
278 AcpiOsPrintf (" ");
279 }
280
281 switch (ObjDesc->Type)
282 {
283 case ACPI_TYPE_ANY:
284
285 AcpiOsPrintf ("[Null Object] (Type=0)\n");
286 break;
287
288 case ACPI_TYPE_INTEGER:
289
290 AcpiOsPrintf ("[Integer] = %8.8X%8.8X\n",
291 ACPI_FORMAT_UINT64 (ObjDesc->Integer.Value));
292 break;
293
294 case ACPI_TYPE_STRING:
295
296 AcpiOsPrintf ("[String] Length %.2X = ", ObjDesc->String.Length);
297 AcpiUtPrintString (ObjDesc->String.Pointer, ACPI_UINT8_MAX);
298 AcpiOsPrintf ("\n");
299 break;
300
301 case ACPI_TYPE_BUFFER:
302
303 AcpiOsPrintf ("[Buffer] Length %.2X = ", ObjDesc->Buffer.Length);
304 if (ObjDesc->Buffer.Length)
305 {
306 if (ObjDesc->Buffer.Length > 16)
307 {
308 AcpiOsPrintf ("\n");
309 }
310
311 AcpiUtDebugDumpBuffer (
312 ACPI_CAST_PTR (UINT8, ObjDesc->Buffer.Pointer),
313 ObjDesc->Buffer.Length, DB_BYTE_DISPLAY, _COMPONENT);
314 }
315 else
316 {
317 AcpiOsPrintf ("\n");
318 }
319 break;
320
321 case ACPI_TYPE_PACKAGE:
322
323 AcpiOsPrintf ("[Package] Contains %u Elements:\n",
324 ObjDesc->Package.Count);
325
326 for (i = 0; i < ObjDesc->Package.Count; i++)
327 {
328 AcpiDbDumpExternalObject (
329 &ObjDesc->Package.Elements[i], Level+1);
330 }
331 break;
332
333 case ACPI_TYPE_LOCAL_REFERENCE:
334
335 AcpiOsPrintf ("[Object Reference] = ");
336 AcpiDbDisplayInternalObject (ObjDesc->Reference.Handle, NULL);
337 break;
338
339 case ACPI_TYPE_PROCESSOR:
340
341 AcpiOsPrintf ("[Processor]\n");
342 break;
343
344 case ACPI_TYPE_POWER:
345
346 AcpiOsPrintf ("[Power Resource]\n");
347 break;
348
349 default:
350
351 AcpiOsPrintf ("[Unknown Type] %X\n", ObjDesc->Type);
352 break;
353 }
354 }
355
356
357 /*******************************************************************************
358 *
359 * FUNCTION: AcpiDbPrepNamestring
360 *
361 * PARAMETERS: Name - String to prepare
362 *
363 * RETURN: None
364 *
365 * DESCRIPTION: Translate all forward slashes and dots to backslashes.
366 *
367 ******************************************************************************/
368
369 void
AcpiDbPrepNamestring(char * Name)370 AcpiDbPrepNamestring (
371 char *Name)
372 {
373
374 if (!Name)
375 {
376 return;
377 }
378
379 AcpiUtStrupr (Name);
380
381 /* Convert a leading forward slash to a backslash */
382
383 if (*Name == '/')
384 {
385 *Name = '\\';
386 }
387
388 /* Ignore a leading backslash, this is the root prefix */
389
390 if (ACPI_IS_ROOT_PREFIX (*Name))
391 {
392 Name++;
393 }
394
395 /* Convert all slash path separators to dots */
396
397 while (*Name)
398 {
399 if ((*Name == '/') ||
400 (*Name == '\\'))
401 {
402 *Name = '.';
403 }
404
405 Name++;
406 }
407 }
408
409
410 /*******************************************************************************
411 *
412 * FUNCTION: AcpiDbLocalNsLookup
413 *
414 * PARAMETERS: Name - Name to lookup
415 *
416 * RETURN: Pointer to a namespace node, null on failure
417 *
418 * DESCRIPTION: Lookup a name in the ACPI namespace
419 *
420 * Note: Currently begins search from the root. Could be enhanced to use
421 * the current prefix (scope) node as the search beginning point.
422 *
423 ******************************************************************************/
424
425 ACPI_NAMESPACE_NODE *
AcpiDbLocalNsLookup(char * Name)426 AcpiDbLocalNsLookup (
427 char *Name)
428 {
429 char *InternalPath;
430 ACPI_STATUS Status;
431 ACPI_NAMESPACE_NODE *Node = NULL;
432
433
434 AcpiDbPrepNamestring (Name);
435
436 /* Build an internal namestring */
437
438 Status = AcpiNsInternalizeName (Name, &InternalPath);
439 if (ACPI_FAILURE (Status))
440 {
441 AcpiOsPrintf ("Invalid namestring: %s\n", Name);
442 return (NULL);
443 }
444
445 /*
446 * Lookup the name.
447 * (Uses root node as the search starting point)
448 */
449 Status = AcpiNsLookup (NULL, InternalPath, ACPI_TYPE_ANY,
450 ACPI_IMODE_EXECUTE, ACPI_NS_NO_UPSEARCH | ACPI_NS_DONT_OPEN_SCOPE,
451 NULL, &Node);
452 if (ACPI_FAILURE (Status))
453 {
454 AcpiOsPrintf ("Could not locate name: %s, %s\n",
455 Name, AcpiFormatException (Status));
456 }
457
458 ACPI_FREE (InternalPath);
459 return (Node);
460 }
461
462
463 /*******************************************************************************
464 *
465 * FUNCTION: AcpiDbUint32ToHexString
466 *
467 * PARAMETERS: Value - The value to be converted to string
468 * Buffer - Buffer for result (not less than 11 bytes)
469 *
470 * RETURN: None
471 *
472 * DESCRIPTION: Convert the unsigned 32-bit value to the hexadecimal image
473 *
474 * NOTE: It is the caller's responsibility to ensure that the length of buffer
475 * is sufficient.
476 *
477 ******************************************************************************/
478
479 void
AcpiDbUint32ToHexString(UINT32 Value,char * Buffer)480 AcpiDbUint32ToHexString (
481 UINT32 Value,
482 char *Buffer)
483 {
484 int i;
485
486
487 if (Value == 0)
488 {
489 strcpy (Buffer, "0");
490 return;
491 }
492
493 Buffer[8] = '\0';
494
495 for (i = 7; i >= 0; i--)
496 {
497 Buffer[i] = AcpiGbl_UpperHexDigits [Value & 0x0F];
498 Value = Value >> 4;
499 }
500 }
501
502
503 #ifdef ACPI_OBSOLETE_FUNCTIONS
504 /*******************************************************************************
505 *
506 * FUNCTION: AcpiDbSecondPassParse
507 *
508 * PARAMETERS: Root - Root of the parse tree
509 *
510 * RETURN: Status
511 *
512 * DESCRIPTION: Second pass parse of the ACPI tables. We need to wait until
513 * second pass to parse the control methods
514 *
515 ******************************************************************************/
516
517 ACPI_STATUS
AcpiDbSecondPassParse(ACPI_PARSE_OBJECT * Root)518 AcpiDbSecondPassParse (
519 ACPI_PARSE_OBJECT *Root)
520 {
521 ACPI_PARSE_OBJECT *Op = Root;
522 ACPI_PARSE_OBJECT *Method;
523 ACPI_PARSE_OBJECT *SearchOp;
524 ACPI_PARSE_OBJECT *StartOp;
525 ACPI_STATUS Status = AE_OK;
526 UINT32 BaseAmlOffset;
527 ACPI_WALK_STATE *WalkState;
528
529
530 ACPI_FUNCTION_ENTRY ();
531
532
533 AcpiOsPrintf ("Pass two parse ....\n");
534
535 while (Op)
536 {
537 if (Op->Common.AmlOpcode == AML_METHOD_OP)
538 {
539 Method = Op;
540
541 /* Create a new walk state for the parse */
542
543 WalkState = AcpiDsCreateWalkState (0, NULL, NULL, NULL);
544 if (!WalkState)
545 {
546 return (AE_NO_MEMORY);
547 }
548
549 /* Init the Walk State */
550
551 WalkState->ParserState.Aml =
552 WalkState->ParserState.AmlStart = Method->Named.Data;
553 WalkState->ParserState.AmlEnd =
554 WalkState->ParserState.PkgEnd = Method->Named.Data +
555 Method->Named.Length;
556 WalkState->ParserState.StartScope = Op;
557
558 WalkState->DescendingCallback = AcpiDsLoad1BeginOp;
559 WalkState->AscendingCallback = AcpiDsLoad1EndOp;
560
561 /* Perform the AML parse */
562
563 Status = AcpiPsParseAml (WalkState);
564
565 BaseAmlOffset = (Method->Common.Value.Arg)->Common.AmlOffset + 1;
566 StartOp = (Method->Common.Value.Arg)->Common.Next;
567 SearchOp = StartOp;
568
569 while (SearchOp)
570 {
571 SearchOp->Common.AmlOffset += BaseAmlOffset;
572 SearchOp = AcpiPsGetDepthNext (StartOp, SearchOp);
573 }
574 }
575
576 if (Op->Common.AmlOpcode == AML_REGION_OP)
577 {
578 /* TBD: [Investigate] this isn't quite the right thing to do! */
579 /*
580 *
581 * Method = (ACPI_DEFERRED_OP *) Op;
582 * Status = AcpiPsParseAml (Op, Method->Body, Method->BodyLength);
583 */
584 }
585
586 if (ACPI_FAILURE (Status))
587 {
588 break;
589 }
590
591 Op = AcpiPsGetDepthNext (Root, Op);
592 }
593
594 return (Status);
595 }
596
597
598 /*******************************************************************************
599 *
600 * FUNCTION: AcpiDbDumpBuffer
601 *
602 * PARAMETERS: Address - Pointer to the buffer
603 *
604 * RETURN: None
605 *
606 * DESCRIPTION: Print a portion of a buffer
607 *
608 ******************************************************************************/
609
610 void
AcpiDbDumpBuffer(UINT32 Address)611 AcpiDbDumpBuffer (
612 UINT32 Address)
613 {
614
615 AcpiOsPrintf ("\nLocation %X:\n", Address);
616
617 AcpiDbgLevel |= ACPI_LV_TABLES;
618 AcpiUtDebugDumpBuffer (ACPI_TO_POINTER (Address), 64, DB_BYTE_DISPLAY,
619 ACPI_UINT32_MAX);
620 }
621 #endif
622
