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