1 /******************************************************************************
2 *
3 * Module Name: aslnamesp - Namespace output file generation
4 *
5 *****************************************************************************/
6
7 /******************************************************************************
8 *
9 * 1. Copyright Notice
10 *
11 * Some or all of this work - Copyright (c) 1999 - 2024, 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 <contrib/dev/acpica/compiler/aslcompiler.h>
153 #include "aslcompiler.y.h"
154 #include <contrib/dev/acpica/include/acnamesp.h>
155
156
157 #define _COMPONENT ACPI_COMPILER
158 ACPI_MODULE_NAME ("aslnamesp")
159
160 /* Local prototypes */
161
162 static ACPI_STATUS
163 NsDoOneNamespaceObject (
164 ACPI_HANDLE ObjHandle,
165 UINT32 Level,
166 void *Context,
167 void **ReturnValue);
168
169 static ACPI_STATUS
170 NsDoOnePathname (
171 ACPI_HANDLE ObjHandle,
172 UINT32 Level,
173 void *Context,
174 void **ReturnValue);
175
176
177 /*******************************************************************************
178 *
179 * FUNCTION: NsSetupNamespaceListing
180 *
181 * PARAMETERS: Handle - local file handle
182 *
183 * RETURN: None
184 *
185 * DESCRIPTION: Set the namespace output file to the input handle
186 *
187 ******************************************************************************/
188
189 void
NsSetupNamespaceListing(void * Handle)190 NsSetupNamespaceListing (
191 void *Handle)
192 {
193
194 AslGbl_NsOutputFlag = TRUE;
195 AslGbl_Files[ASL_FILE_NAMESPACE_OUTPUT].Handle = Handle;
196 }
197
198
199 /*******************************************************************************
200 *
201 * FUNCTION: NsDisplayNamespace
202 *
203 * PARAMETERS: None
204 *
205 * RETURN: Status
206 *
207 * DESCRIPTION: Walk the namespace an display information about each node
208 * in the tree. Information is written to the optional
209 * namespace output file.
210 *
211 ******************************************************************************/
212
213 ACPI_STATUS
NsDisplayNamespace(void)214 NsDisplayNamespace (
215 void)
216 {
217 ACPI_STATUS Status;
218
219
220 if (!AslGbl_NsOutputFlag)
221 {
222 return (AE_OK);
223 }
224
225 AslGbl_NumNamespaceObjects = 0;
226
227 /* File header */
228
229 FlPrintFile (ASL_FILE_NAMESPACE_OUTPUT, "Contents of ACPI Namespace\n\n"
230 "Count Depth Name - Type\n\n");
231
232 /* Walk entire namespace from the root */
233
234 Status = AcpiNsWalkNamespace (ACPI_TYPE_ANY, ACPI_ROOT_OBJECT,
235 ACPI_UINT32_MAX, FALSE, NsDoOneNamespaceObject, NULL,
236 NULL, NULL);
237 if (ACPI_FAILURE (Status))
238 {
239 return (Status);
240 }
241
242 /* Print the full pathname for each namespace node in the common namespace */
243
244 FlPrintFile (ASL_FILE_NAMESPACE_OUTPUT,
245 "\nNamespace pathnames and where declared:\n"
246 "<NamePath, Object type, Containing file, Line number within file>\n\n");
247
248 Status = AcpiNsWalkNamespace (ACPI_TYPE_ANY, ACPI_ROOT_OBJECT,
249 ACPI_UINT32_MAX, FALSE, NsDoOnePathname, NULL,
250 NULL, NULL);
251
252 /*
253 * We just dumped the entire common namespace, we don't want to do it
254 * again for other input files.
255 */
256 AslGbl_NsOutputFlag = FALSE;
257 return (Status);
258 }
259
260
261 /*******************************************************************************
262 *
263 * FUNCTION: NsDoOneNamespaceObject
264 *
265 * PARAMETERS: ACPI_WALK_CALLBACK
266 *
267 * RETURN: Status
268 *
269 * DESCRIPTION: Dump a namespace object to the namespace output file.
270 * Called during the walk of the namespace to dump all objects.
271 *
272 ******************************************************************************/
273
274 static ACPI_STATUS
NsDoOneNamespaceObject(ACPI_HANDLE ObjHandle,UINT32 Level,void * Context,void ** ReturnValue)275 NsDoOneNamespaceObject (
276 ACPI_HANDLE ObjHandle,
277 UINT32 Level,
278 void *Context,
279 void **ReturnValue)
280 {
281 ACPI_NAMESPACE_NODE *Node = (ACPI_NAMESPACE_NODE *) ObjHandle;
282 ACPI_OPERAND_OBJECT *ObjDesc;
283 ACPI_PARSE_OBJECT *Op;
284
285
286 AslGbl_NumNamespaceObjects++;
287
288 FlPrintFile (ASL_FILE_NAMESPACE_OUTPUT, "%5u [%u] %*s %4.4s - %s",
289 AslGbl_NumNamespaceObjects, Level, (Level * 3), " ",
290 &Node->Name.Ascii[0], AcpiUtGetTypeName (Node->Type));
291
292 Op = Node->Op;
293 ObjDesc = ACPI_CAST_PTR (ACPI_OPERAND_OBJECT, Node->Object);
294
295 if (!Op)
296 {
297 FlPrintFile (ASL_FILE_NAMESPACE_OUTPUT, "\n");
298 return (AE_OK);
299 }
300
301
302 if ((ObjDesc) &&
303 (ACPI_GET_DESCRIPTOR_TYPE (ObjDesc) == ACPI_DESC_TYPE_OPERAND))
304 {
305 switch (Node->Type)
306 {
307 case ACPI_TYPE_INTEGER:
308
309 FlPrintFile (ASL_FILE_NAMESPACE_OUTPUT,
310 " [Initial Value 0x%8.8X%8.8X]",
311 ACPI_FORMAT_UINT64 (ObjDesc->Integer.Value));
312 break;
313
314 case ACPI_TYPE_STRING:
315
316 FlPrintFile (ASL_FILE_NAMESPACE_OUTPUT,
317 " [Initial Value \"%s\"]",
318 ObjDesc->String.Pointer);
319 break;
320
321 default:
322
323 /* Nothing to do for other types */
324
325 break;
326 }
327
328 }
329 else
330 {
331 switch (Node->Type)
332 {
333 case ACPI_TYPE_INTEGER:
334
335 if (Op->Asl.ParseOpcode == PARSEOP_NAME)
336 {
337 Op = Op->Asl.Child;
338 }
339
340 if ((Op->Asl.ParseOpcode == PARSEOP_NAMESEG) ||
341 (Op->Asl.ParseOpcode == PARSEOP_NAMESTRING))
342 {
343 Op = Op->Asl.Next;
344 }
345
346 FlPrintFile (ASL_FILE_NAMESPACE_OUTPUT,
347 " [Initial Value 0x%8.8X%8.8X]",
348 ACPI_FORMAT_UINT64 (Op->Asl.Value.Integer));
349 break;
350
351 case ACPI_TYPE_STRING:
352
353 if (Op->Asl.ParseOpcode == PARSEOP_NAME)
354 {
355 Op = Op->Asl.Child;
356 }
357
358 if ((Op->Asl.ParseOpcode == PARSEOP_NAMESEG) ||
359 (Op->Asl.ParseOpcode == PARSEOP_NAMESTRING))
360 {
361 Op = Op->Asl.Next;
362 }
363
364 FlPrintFile (ASL_FILE_NAMESPACE_OUTPUT,
365 " [Initial Value \"%s\"]",
366 Op->Asl.Value.String);
367 break;
368
369 case ACPI_TYPE_LOCAL_REGION_FIELD:
370
371 if ((Op->Asl.ParseOpcode == PARSEOP_NAMESEG) ||
372 (Op->Asl.ParseOpcode == PARSEOP_NAMESTRING))
373 {
374 Op = Op->Asl.Child;
375 }
376
377 FlPrintFile (ASL_FILE_NAMESPACE_OUTPUT,
378 " [Offset 0x%04X Length 0x%04X bits]",
379 Op->Asl.Parent->Asl.ExtraValue, (UINT32) Op->Asl.Value.Integer);
380 break;
381
382 case ACPI_TYPE_BUFFER_FIELD:
383
384 switch (Op->Asl.ParseOpcode)
385 {
386 case PARSEOP_CREATEBYTEFIELD:
387
388 FlPrintFile (ASL_FILE_NAMESPACE_OUTPUT, " [BYTE ( 8 bit)]");
389 break;
390
391 case PARSEOP_CREATEDWORDFIELD:
392
393 FlPrintFile (ASL_FILE_NAMESPACE_OUTPUT, " [DWORD (32 bit)]");
394 break;
395
396 case PARSEOP_CREATEQWORDFIELD:
397
398 FlPrintFile (ASL_FILE_NAMESPACE_OUTPUT, " [QWORD (64 bit)]");
399 break;
400
401 case PARSEOP_CREATEWORDFIELD:
402
403 FlPrintFile (ASL_FILE_NAMESPACE_OUTPUT, " [WORD (16 bit)]");
404 break;
405
406 case PARSEOP_CREATEBITFIELD:
407
408 FlPrintFile (ASL_FILE_NAMESPACE_OUTPUT, " [BIT ( 1 bit)]");
409 break;
410
411 case PARSEOP_CREATEFIELD:
412
413 FlPrintFile (ASL_FILE_NAMESPACE_OUTPUT, " [Arbitrary Bit Field]");
414 break;
415
416 default:
417
418 break;
419
420 }
421 break;
422
423 case ACPI_TYPE_PACKAGE:
424
425 if (Op->Asl.ParseOpcode == PARSEOP_NAME)
426 {
427 Op = Op->Asl.Child;
428 }
429
430 if ((Op->Asl.ParseOpcode == PARSEOP_NAMESEG) ||
431 (Op->Asl.ParseOpcode == PARSEOP_NAMESTRING))
432 {
433 Op = Op->Asl.Next;
434 }
435
436 Op = Op->Asl.Child;
437
438 if ((Op->Asl.ParseOpcode == PARSEOP_BYTECONST) ||
439 (Op->Asl.ParseOpcode == PARSEOP_RAW_DATA))
440 {
441 FlPrintFile (ASL_FILE_NAMESPACE_OUTPUT,
442 " [Initial Length 0x%.2X elements]",
443 (UINT32) Op->Asl.Value.Integer);
444 }
445 break;
446
447 case ACPI_TYPE_BUFFER:
448
449 if (Op->Asl.ParseOpcode == PARSEOP_NAME)
450 {
451 Op = Op->Asl.Child;
452 }
453
454 if ((Op->Asl.ParseOpcode == PARSEOP_NAMESEG) ||
455 (Op->Asl.ParseOpcode == PARSEOP_NAMESTRING))
456 {
457 Op = Op->Asl.Next;
458 }
459
460 Op = Op->Asl.Child;
461
462 if (Op && (Op->Asl.ParseOpcode == PARSEOP_INTEGER))
463 {
464 FlPrintFile (ASL_FILE_NAMESPACE_OUTPUT,
465 " [Initial Length 0x%.2X bytes]",
466 (UINT32) Op->Asl.Value.Integer);
467 }
468 break;
469
470 case ACPI_TYPE_METHOD:
471
472 FlPrintFile (ASL_FILE_NAMESPACE_OUTPUT,
473 " [Code Length 0x%.4X bytes]",
474 Op->Asl.AmlSubtreeLength);
475 break;
476
477 case ACPI_TYPE_LOCAL_RESOURCE:
478
479 FlPrintFile (ASL_FILE_NAMESPACE_OUTPUT,
480 " [Desc Offset 0x%.4X Bytes]", Node->Value);
481 break;
482
483 case ACPI_TYPE_LOCAL_RESOURCE_FIELD:
484
485 FlPrintFile (ASL_FILE_NAMESPACE_OUTPUT,
486 " [Field Offset 0x%.4X Bits 0x%.4X Bytes] ",
487 Node->Value, Node->Value / 8);
488
489 if (Node->Flags & ANOBJ_IS_REFERENCED)
490 {
491 FlPrintFile (ASL_FILE_NAMESPACE_OUTPUT,
492 "Referenced");
493 }
494 else
495 {
496 FlPrintFile (ASL_FILE_NAMESPACE_OUTPUT,
497 "Name not referenced");
498 }
499 break;
500
501 default:
502
503 /* Nothing to do for other types */
504
505 break;
506 }
507 }
508
509 FlPrintFile (ASL_FILE_NAMESPACE_OUTPUT, "\n");
510 return (AE_OK);
511 }
512
513
514 /*******************************************************************************
515 *
516 * FUNCTION: NsDoOnePathname
517 *
518 * PARAMETERS: ACPI_WALK_CALLBACK
519 *
520 * RETURN: Status
521 *
522 * DESCRIPTION: Print the full pathname and additional info for a namespace
523 * node.
524 *
525 ******************************************************************************/
526
527 static ACPI_STATUS
NsDoOnePathname(ACPI_HANDLE ObjHandle,UINT32 Level,void * Context,void ** ReturnValue)528 NsDoOnePathname (
529 ACPI_HANDLE ObjHandle,
530 UINT32 Level,
531 void *Context,
532 void **ReturnValue)
533 {
534 ACPI_NAMESPACE_NODE *Node = (ACPI_NAMESPACE_NODE *) ObjHandle;
535 ACPI_STATUS Status;
536 ACPI_BUFFER TargetPath;
537
538
539 /* Ignore predefined namespace nodes and External declarations */
540
541 if (!Node->Op || (Node->Flags & ANOBJ_IS_EXTERNAL))
542 {
543 return (AE_OK);
544 }
545
546 TargetPath.Length = ACPI_ALLOCATE_LOCAL_BUFFER;
547 Status = AcpiNsHandleToPathname (Node, &TargetPath, FALSE);
548 if (ACPI_FAILURE (Status))
549 {
550 return (Status);
551 }
552
553 /*
554 * Print the full pathname (and other information)
555 * for each namespace node in the common namespace
556 */
557 FlPrintFile (ASL_FILE_NAMESPACE_OUTPUT, "%-41s %-12s %s, %u\n",
558 ACPI_CAST_PTR (char, TargetPath.Pointer),
559 AcpiUtGetTypeName (Node->Type),
560 Node->Op->Asl.Filename, Node->Op->Asl.LogicalLineNumber);
561
562 ACPI_FREE (TargetPath.Pointer);
563 return (AE_OK);
564 }
565