1 /*******************************************************************************
2 *
3 * Module Name: dmnames - AML disassembler, names, namestrings, pathnames
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 "amlcode.h"
155 #include "acnamesp.h"
156 #include "acdisasm.h"
157
158
159 #define _COMPONENT ACPI_CA_DEBUGGER
160 ACPI_MODULE_NAME ("dmnames")
161
162 /* Local prototypes */
163
164 #ifdef ACPI_OBSOLETE_FUNCTIONS
165 void
166 AcpiDmDisplayPath (
167 ACPI_PARSE_OBJECT *Op);
168 #endif
169
170
171 /*******************************************************************************
172 *
173 * FUNCTION: AcpiDmDumpName
174 *
175 * PARAMETERS: Name - 4 character ACPI name
176 *
177 * RETURN: Final length of name
178 *
179 * DESCRIPTION: Dump an ACPI name, minus any trailing underscores.
180 *
181 ******************************************************************************/
182
183 UINT32
AcpiDmDumpName(UINT32 Name)184 AcpiDmDumpName (
185 UINT32 Name)
186 {
187 UINT32 i;
188 UINT32 Length;
189 char NewName[4];
190
191
192 /* Copy name locally in case the original name is not writeable */
193
194 *ACPI_CAST_PTR (UINT32, &NewName[0]) = Name;
195
196 /* Ensure that the name is printable, even if we have to fix it */
197
198 AcpiUtRepairName (NewName);
199
200 /* Remove all trailing underscores from the name */
201
202 Length = ACPI_NAMESEG_SIZE;
203 for (i = (ACPI_NAMESEG_SIZE - 1); i != 0; i--)
204 {
205 if (NewName[i] == '_')
206 {
207 Length--;
208 }
209 else
210 {
211 break;
212 }
213 }
214
215 /* Dump the name, up to the start of the trailing underscores */
216
217 for (i = 0; i < Length; i++)
218 {
219 AcpiOsPrintf ("%c", NewName[i]);
220 }
221
222 return (Length);
223 }
224
225
226 /*******************************************************************************
227 *
228 * FUNCTION: AcpiPsDisplayObjectPathname
229 *
230 * PARAMETERS: WalkState - Current walk state
231 * Op - Object whose pathname is to be obtained
232 *
233 * RETURN: Status
234 *
235 * DESCRIPTION: Display the pathname associated with a named object. Two
236 * versions. One searches the parse tree (for parser-only
237 * applications suchas AcpiDump), and the other searches the
238 * ACPI namespace (the parse tree is probably deleted)
239 *
240 ******************************************************************************/
241
242 ACPI_STATUS
AcpiPsDisplayObjectPathname(ACPI_WALK_STATE * WalkState,ACPI_PARSE_OBJECT * Op)243 AcpiPsDisplayObjectPathname (
244 ACPI_WALK_STATE *WalkState,
245 ACPI_PARSE_OBJECT *Op)
246 {
247 ACPI_STATUS Status;
248 ACPI_NAMESPACE_NODE *Node;
249 ACPI_BUFFER Buffer;
250 UINT32 DebugLevel;
251
252
253 /* Save current debug level so we don't get extraneous debug output */
254
255 DebugLevel = AcpiDbgLevel;
256 AcpiDbgLevel = 0;
257
258 /* Just get the Node out of the Op object */
259
260 Node = Op->Common.Node;
261 if (!Node)
262 {
263 /* Node not defined in this scope, look it up */
264
265 Status = AcpiNsLookup (WalkState->ScopeInfo, Op->Common.Value.String,
266 ACPI_TYPE_ANY, ACPI_IMODE_EXECUTE, ACPI_NS_SEARCH_PARENT,
267 WalkState, &(Node));
268
269 if (ACPI_FAILURE (Status))
270 {
271 /*
272 * We can't get the pathname since the object is not in the
273 * namespace. This can happen during single stepping
274 * where a dynamic named object is *about* to be created.
275 */
276 AcpiOsPrintf (" [Path not found]");
277 goto Exit;
278 }
279
280 /* Save it for next time. */
281
282 Op->Common.Node = Node;
283 }
284
285 /* Convert NamedDesc/handle to a full pathname */
286
287 Buffer.Length = ACPI_ALLOCATE_LOCAL_BUFFER;
288 Status = AcpiNsHandleToPathname (Node, &Buffer, FALSE);
289 if (ACPI_FAILURE (Status))
290 {
291 AcpiOsPrintf ("****Could not get pathname****)");
292 goto Exit;
293 }
294
295 AcpiOsPrintf (" (Path %s)", (char *) Buffer.Pointer);
296 ACPI_FREE (Buffer.Pointer);
297
298
299 Exit:
300 /* Restore the debug level */
301
302 AcpiDbgLevel = DebugLevel;
303 return (Status);
304 }
305
306
307 /*******************************************************************************
308 *
309 * FUNCTION: AcpiDmNamestring
310 *
311 * PARAMETERS: Name - ACPI Name string to store
312 *
313 * RETURN: None
314 *
315 * DESCRIPTION: Decode and dump an ACPI namestring. Handles prefix characters
316 *
317 ******************************************************************************/
318
319 void
AcpiDmNamestring(char * Name)320 AcpiDmNamestring (
321 char *Name)
322 {
323 UINT32 SegCount;
324
325
326 if (!Name)
327 {
328 return;
329 }
330
331 /* Handle all Scope Prefix operators */
332
333 while (ACPI_IS_ROOT_PREFIX (ACPI_GET8 (Name)) ||
334 ACPI_IS_PARENT_PREFIX (ACPI_GET8 (Name)))
335 {
336 /* Append prefix character */
337
338 AcpiOsPrintf ("%1c", ACPI_GET8 (Name));
339 Name++;
340 }
341
342 switch (ACPI_GET8 (Name))
343 {
344 case 0:
345
346 SegCount = 0;
347 break;
348
349 case AML_DUAL_NAME_PREFIX:
350
351 SegCount = 2;
352 Name++;
353 break;
354
355 case AML_MULTI_NAME_PREFIX:
356
357 SegCount = (UINT32) ACPI_GET8 (Name + 1);
358 Name += 2;
359 break;
360
361 default:
362
363 SegCount = 1;
364 break;
365 }
366
367 while (SegCount)
368 {
369 /* Append Name segment */
370
371 AcpiDmDumpName (*ACPI_CAST_PTR (UINT32, Name));
372
373 SegCount--;
374 if (SegCount)
375 {
376 /* Not last name, append dot separator */
377
378 AcpiOsPrintf (".");
379 }
380
381 Name += ACPI_NAMESEG_SIZE;
382 }
383 }
384
385
386 #ifdef ACPI_OBSOLETE_FUNCTIONS
387 /*******************************************************************************
388 *
389 * FUNCTION: AcpiDmDisplayPath
390 *
391 * PARAMETERS: Op - Named Op whose path is to be constructed
392 *
393 * RETURN: None
394 *
395 * DESCRIPTION: Walk backwards from current scope and display the name
396 * of each previous level of scope up to the root scope
397 * (like "pwd" does with file systems)
398 *
399 ******************************************************************************/
400
401 void
AcpiDmDisplayPath(ACPI_PARSE_OBJECT * Op)402 AcpiDmDisplayPath (
403 ACPI_PARSE_OBJECT *Op)
404 {
405 ACPI_PARSE_OBJECT *Prev;
406 ACPI_PARSE_OBJECT *Search;
407 UINT32 Name;
408 BOOLEAN DoDot = FALSE;
409 ACPI_PARSE_OBJECT *NamePath;
410 const ACPI_OPCODE_INFO *OpInfo;
411
412
413 /* We are only interested in named objects */
414
415 OpInfo = AcpiPsGetOpcodeInfo (Op->Common.AmlOpcode);
416 if (!(OpInfo->Flags & AML_NSNODE))
417 {
418 return;
419 }
420
421 if (OpInfo->Flags & AML_CREATE)
422 {
423 /* Field creation - check for a fully qualified namepath */
424
425 if (Op->Common.AmlOpcode == AML_CREATE_FIELD_OP)
426 {
427 NamePath = AcpiPsGetArg (Op, 3);
428 }
429 else
430 {
431 NamePath = AcpiPsGetArg (Op, 2);
432 }
433
434 if ((NamePath) &&
435 (NamePath->Common.Value.String) &&
436 (ACPI_IS_ROOT_PREFIX (NamePath->Common.Value.String[0])))
437 {
438 AcpiDmNamestring (NamePath->Common.Value.String);
439 return;
440 }
441 }
442
443 Prev = NULL; /* Start with Root Node */
444 while (Prev != Op)
445 {
446 /* Search upwards in the tree to find scope with "prev" as its parent */
447
448 Search = Op;
449 for (; ;)
450 {
451 if (Search->Common.Parent == Prev)
452 {
453 break;
454 }
455
456 /* Go up one level */
457
458 Search = Search->Common.Parent;
459 }
460
461 if (Prev)
462 {
463 OpInfo = AcpiPsGetOpcodeInfo (Search->Common.AmlOpcode);
464 if (!(OpInfo->Flags & AML_FIELD))
465 {
466 /* Below root scope, append scope name */
467
468 if (DoDot)
469 {
470 /* Append dot */
471
472 AcpiOsPrintf (".");
473 }
474
475 if (OpInfo->Flags & AML_CREATE)
476 {
477 if (Op->Common.AmlOpcode == AML_CREATE_FIELD_OP)
478 {
479 NamePath = AcpiPsGetArg (Op, 3);
480 }
481 else
482 {
483 NamePath = AcpiPsGetArg (Op, 2);
484 }
485
486 if ((NamePath) &&
487 (NamePath->Common.Value.String))
488 {
489 AcpiDmDumpName (NamePath->Common.Value.String);
490 }
491 }
492 else
493 {
494 Name = AcpiPsGetName (Search);
495 AcpiDmDumpName ((char *) &Name);
496 }
497
498 DoDot = TRUE;
499 }
500 }
501
502 Prev = Search;
503 }
504 }
505
506
507 /*******************************************************************************
508 *
509 * FUNCTION: AcpiDmValidateName
510 *
511 * PARAMETERS: Name - 4 character ACPI name
512 *
513 * RETURN: None
514 *
515 * DESCRIPTION: Lookup the name
516 *
517 ******************************************************************************/
518
519 void
AcpiDmValidateName(char * Name,ACPI_PARSE_OBJECT * Op)520 AcpiDmValidateName (
521 char *Name,
522 ACPI_PARSE_OBJECT *Op)
523 {
524 ACPI_PARSE_OBJECT *TargetOp;
525
526
527 if ((!Name) ||
528 (!Op->Common.Parent))
529 {
530 return;
531 }
532
533 if (!Op->Common.Node)
534 {
535 AcpiOsPrintf (
536 " /**** Name not found or not accessible from this scope ****/ ");
537 }
538
539 if ((!Name) ||
540 (!Op->Common.Parent))
541 {
542 return;
543 }
544
545 TargetOp = AcpiPsFind (Op, Name, 0, 0);
546 if (!TargetOp)
547 {
548 /*
549 * Didn't find the name in the parse tree. This may be
550 * a problem, or it may simply be one of the predefined names
551 * (such as _OS_). Rather than worry about looking up all
552 * the predefined names, just display the name as given
553 */
554 AcpiOsPrintf (
555 " /**** Name not found or not accessible from this scope ****/ ");
556 }
557 }
558 #endif
559
