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 - 2018, 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 "aslcompiler.h"
153 #include "aslcompiler.y.h"
154 #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 Gbl_NsOutputFlag = TRUE;
195 Gbl_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 (!Gbl_NsOutputFlag)
221 {
222 return (AE_OK);
223 }
224
225 Gbl_NumNamespaceObjects = 0;
226
227 /* File header */
228
229 FlPrintFile (ASL_FILE_NAMESPACE_OUTPUT, "Contents of ACPI Namespace\n\n");
230 FlPrintFile (ASL_FILE_NAMESPACE_OUTPUT, "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
238 /* Print the full pathname for each namespace node */
239
240 FlPrintFile (ASL_FILE_NAMESPACE_OUTPUT, "\nNamespace pathnames\n\n");
241
242 Status = AcpiNsWalkNamespace (ACPI_TYPE_ANY, ACPI_ROOT_OBJECT,
243 ACPI_UINT32_MAX, FALSE, NsDoOnePathname, NULL,
244 NULL, NULL);
245
246 return (Status);
247 }
248
249
250 /*******************************************************************************
251 *
252 * FUNCTION: NsDoOneNamespaceObject
253 *
254 * PARAMETERS: ACPI_WALK_CALLBACK
255 *
256 * RETURN: Status
257 *
258 * DESCRIPTION: Dump a namespace object to the namespace output file.
259 * Called during the walk of the namespace to dump all objects.
260 *
261 ******************************************************************************/
262
263 static ACPI_STATUS
NsDoOneNamespaceObject(ACPI_HANDLE ObjHandle,UINT32 Level,void * Context,void ** ReturnValue)264 NsDoOneNamespaceObject (
265 ACPI_HANDLE ObjHandle,
266 UINT32 Level,
267 void *Context,
268 void **ReturnValue)
269 {
270 ACPI_NAMESPACE_NODE *Node = (ACPI_NAMESPACE_NODE *) ObjHandle;
271 ACPI_OPERAND_OBJECT *ObjDesc;
272 ACPI_PARSE_OBJECT *Op;
273
274
275 Gbl_NumNamespaceObjects++;
276
277 FlPrintFile (ASL_FILE_NAMESPACE_OUTPUT, "%5u [%u] %*s %4.4s - %s",
278 Gbl_NumNamespaceObjects, Level, (Level * 3), " ",
279 &Node->Name, AcpiUtGetTypeName (Node->Type));
280
281 Op = Node->Op;
282 ObjDesc = ACPI_CAST_PTR (ACPI_OPERAND_OBJECT, Node->Object);
283
284 if (!Op)
285 {
286 FlPrintFile (ASL_FILE_NAMESPACE_OUTPUT, "\n");
287 return (AE_OK);
288 }
289
290
291 if ((ObjDesc) &&
292 (ACPI_GET_DESCRIPTOR_TYPE (ObjDesc) == ACPI_DESC_TYPE_OPERAND))
293 {
294 switch (Node->Type)
295 {
296 case ACPI_TYPE_INTEGER:
297
298 FlPrintFile (ASL_FILE_NAMESPACE_OUTPUT,
299 " [Initial Value 0x%8.8X%8.8X]",
300 ACPI_FORMAT_UINT64 (ObjDesc->Integer.Value));
301 break;
302
303 case ACPI_TYPE_STRING:
304
305 FlPrintFile (ASL_FILE_NAMESPACE_OUTPUT,
306 " [Initial Value \"%s\"]",
307 ObjDesc->String.Pointer);
308 break;
309
310 default:
311
312 /* Nothing to do for other types */
313
314 break;
315 }
316
317 }
318 else
319 {
320 switch (Node->Type)
321 {
322 case ACPI_TYPE_INTEGER:
323
324 if (Op->Asl.ParseOpcode == PARSEOP_NAME)
325 {
326 Op = Op->Asl.Child;
327 }
328
329 if ((Op->Asl.ParseOpcode == PARSEOP_NAMESEG) ||
330 (Op->Asl.ParseOpcode == PARSEOP_NAMESTRING))
331 {
332 Op = Op->Asl.Next;
333 }
334
335 FlPrintFile (ASL_FILE_NAMESPACE_OUTPUT,
336 " [Initial Value 0x%8.8X%8.8X]",
337 ACPI_FORMAT_UINT64 (Op->Asl.Value.Integer));
338 break;
339
340 case ACPI_TYPE_STRING:
341
342 if (Op->Asl.ParseOpcode == PARSEOP_NAME)
343 {
344 Op = Op->Asl.Child;
345 }
346
347 if ((Op->Asl.ParseOpcode == PARSEOP_NAMESEG) ||
348 (Op->Asl.ParseOpcode == PARSEOP_NAMESTRING))
349 {
350 Op = Op->Asl.Next;
351 }
352
353 FlPrintFile (ASL_FILE_NAMESPACE_OUTPUT,
354 " [Initial Value \"%s\"]",
355 Op->Asl.Value.String);
356 break;
357
358 case ACPI_TYPE_LOCAL_REGION_FIELD:
359
360 if ((Op->Asl.ParseOpcode == PARSEOP_NAMESEG) ||
361 (Op->Asl.ParseOpcode == PARSEOP_NAMESTRING))
362 {
363 Op = Op->Asl.Child;
364 }
365
366 FlPrintFile (ASL_FILE_NAMESPACE_OUTPUT,
367 " [Offset 0x%04X Length 0x%04X bits]",
368 Op->Asl.Parent->Asl.ExtraValue, (UINT32) Op->Asl.Value.Integer);
369 break;
370
371 case ACPI_TYPE_BUFFER_FIELD:
372
373 switch (Op->Asl.ParseOpcode)
374 {
375 case PARSEOP_CREATEBYTEFIELD:
376
377 FlPrintFile (ASL_FILE_NAMESPACE_OUTPUT, " [BYTE ( 8 bit)]");
378 break;
379
380 case PARSEOP_CREATEDWORDFIELD:
381
382 FlPrintFile (ASL_FILE_NAMESPACE_OUTPUT, " [DWORD (32 bit)]");
383 break;
384
385 case PARSEOP_CREATEQWORDFIELD:
386
387 FlPrintFile (ASL_FILE_NAMESPACE_OUTPUT, " [QWORD (64 bit)]");
388 break;
389
390 case PARSEOP_CREATEWORDFIELD:
391
392 FlPrintFile (ASL_FILE_NAMESPACE_OUTPUT, " [WORD (16 bit)]");
393 break;
394
395 case PARSEOP_CREATEBITFIELD:
396
397 FlPrintFile (ASL_FILE_NAMESPACE_OUTPUT, " [BIT ( 1 bit)]");
398 break;
399
400 case PARSEOP_CREATEFIELD:
401
402 FlPrintFile (ASL_FILE_NAMESPACE_OUTPUT, " [Arbitrary Bit Field]");
403 break;
404
405 default:
406
407 break;
408
409 }
410 break;
411
412 case ACPI_TYPE_PACKAGE:
413
414 if (Op->Asl.ParseOpcode == PARSEOP_NAME)
415 {
416 Op = Op->Asl.Child;
417 }
418
419 if ((Op->Asl.ParseOpcode == PARSEOP_NAMESEG) ||
420 (Op->Asl.ParseOpcode == PARSEOP_NAMESTRING))
421 {
422 Op = Op->Asl.Next;
423 }
424
425 Op = Op->Asl.Child;
426
427 if ((Op->Asl.ParseOpcode == PARSEOP_BYTECONST) ||
428 (Op->Asl.ParseOpcode == PARSEOP_RAW_DATA))
429 {
430 FlPrintFile (ASL_FILE_NAMESPACE_OUTPUT,
431 " [Initial Length 0x%.2X elements]",
432 Op->Asl.Value.Integer);
433 }
434 break;
435
436 case ACPI_TYPE_BUFFER:
437
438 if (Op->Asl.ParseOpcode == PARSEOP_NAME)
439 {
440 Op = Op->Asl.Child;
441 }
442
443 if ((Op->Asl.ParseOpcode == PARSEOP_NAMESEG) ||
444 (Op->Asl.ParseOpcode == PARSEOP_NAMESTRING))
445 {
446 Op = Op->Asl.Next;
447 }
448
449 Op = Op->Asl.Child;
450
451 if (Op && (Op->Asl.ParseOpcode == PARSEOP_INTEGER))
452 {
453 FlPrintFile (ASL_FILE_NAMESPACE_OUTPUT,
454 " [Initial Length 0x%.2X bytes]",
455 Op->Asl.Value.Integer);
456 }
457 break;
458
459 case ACPI_TYPE_METHOD:
460
461 FlPrintFile (ASL_FILE_NAMESPACE_OUTPUT,
462 " [Code Length 0x%.4X bytes]",
463 Op->Asl.AmlSubtreeLength);
464 break;
465
466 case ACPI_TYPE_LOCAL_RESOURCE:
467
468 FlPrintFile (ASL_FILE_NAMESPACE_OUTPUT,
469 " [Desc Offset 0x%.4X Bytes]", Node->Value);
470 break;
471
472 case ACPI_TYPE_LOCAL_RESOURCE_FIELD:
473
474 FlPrintFile (ASL_FILE_NAMESPACE_OUTPUT,
475 " [Field Offset 0x%.4X Bits 0x%.4X Bytes] ",
476 Node->Value, Node->Value / 8);
477
478 if (Node->Flags & ANOBJ_IS_REFERENCED)
479 {
480 FlPrintFile (ASL_FILE_NAMESPACE_OUTPUT,
481 "Referenced");
482 }
483 else
484 {
485 FlPrintFile (ASL_FILE_NAMESPACE_OUTPUT,
486 "Name not referenced");
487 }
488 break;
489
490 default:
491
492 /* Nothing to do for other types */
493
494 break;
495 }
496 }
497
498 FlPrintFile (ASL_FILE_NAMESPACE_OUTPUT, "\n");
499 return (AE_OK);
500 }
501
502
503 /*******************************************************************************
504 *
505 * FUNCTION: NsDoOnePathname
506 *
507 * PARAMETERS: ACPI_WALK_CALLBACK
508 *
509 * RETURN: Status
510 *
511 * DESCRIPTION: Print the full pathname for a namespace node.
512 *
513 ******************************************************************************/
514
515 static ACPI_STATUS
NsDoOnePathname(ACPI_HANDLE ObjHandle,UINT32 Level,void * Context,void ** ReturnValue)516 NsDoOnePathname (
517 ACPI_HANDLE ObjHandle,
518 UINT32 Level,
519 void *Context,
520 void **ReturnValue)
521 {
522 ACPI_NAMESPACE_NODE *Node = (ACPI_NAMESPACE_NODE *) ObjHandle;
523 ACPI_STATUS Status;
524 ACPI_BUFFER TargetPath;
525
526
527 TargetPath.Length = ACPI_ALLOCATE_LOCAL_BUFFER;
528 Status = AcpiNsHandleToPathname (Node, &TargetPath, FALSE);
529 if (ACPI_FAILURE (Status))
530 {
531 return (Status);
532 }
533
534 FlPrintFile (ASL_FILE_NAMESPACE_OUTPUT, "%s\n", TargetPath.Pointer);
535 ACPI_FREE (TargetPath.Pointer);
536 return (AE_OK);
537 }
538