xref: /freebsd/sys/contrib/dev/acpica/compiler/aslmapoutput.c (revision 5f4c09dd85bff675e0ca63c55ea3c517e0fddfcc)
1 /******************************************************************************
2  *
3  * Module Name: aslmapoutput - Output/emit the resource descriptor/device maps
4  *
5  *****************************************************************************/
6 
7 /******************************************************************************
8  *
9  * 1. Copyright Notice
10  *
11  * Some or all of this work - Copyright (c) 1999 - 2022, 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/include/acpi.h>
153 #include <contrib/dev/acpica/include/accommon.h>
154 #include <contrib/dev/acpica/include/acapps.h>
155 #include <contrib/dev/acpica/compiler/aslcompiler.h>
156 #include "aslcompiler.y.h"
157 #include <contrib/dev/acpica/include/acinterp.h>
158 #include <contrib/dev/acpica/include/acparser.h>
159 #include <contrib/dev/acpica/include/acnamesp.h>
160 #include <contrib/dev/acpica/include/amlcode.h>
161 
162 /* This module used for application-level code only */
163 
164 #define _COMPONENT          ACPI_COMPILER
165         ACPI_MODULE_NAME    ("aslmapoutput")
166 
167 /* Local prototypes */
168 
169 static void
170 MpEmitGpioInfo (
171     void);
172 
173 static void
174 MpEmitSerialInfo (
175     void);
176 
177 static void
178 MpEmitDeviceTree (
179     void);
180 
181 static ACPI_STATUS
182 MpEmitOneDevice (
183     ACPI_HANDLE             ObjHandle,
184     UINT32                  NestingLevel,
185     void                    *Context,
186     void                    **ReturnValue);
187 
188 static void
189 MpXrefDevices (
190     ACPI_GPIO_INFO          *Info);
191 
192 static ACPI_STATUS
193 MpNamespaceXrefBegin (
194     ACPI_PARSE_OBJECT       *Op,
195     UINT32                  Level,
196     void                    *Context);
197 
198 
199 /* Strings used to decode flag bits */
200 
201 const char                  *DirectionDecode[] =
202 {
203     "Both I/O   ",
204     "InputOnly  ",
205     "OutputOnly ",
206     "Preserve   "
207 };
208 
209 const char                  *PolarityDecode[] =
210 {
211     "ActiveHigh",
212     "ActiveLow ",
213     "ActiveBoth",
214     "Reserved  "
215 };
216 
217 
218 /*******************************************************************************
219  *
220  * FUNCTION:    MpEmitMappingInfo
221  *
222  * PARAMETERS:  None
223  *
224  * RETURN:      None
225  *
226  * DESCRIPTION: External interface.
227  *              Map file has already been opened. Emit all of the collected
228  *              hardware mapping information. Includes: GPIO information,
229  *              Serial information, and a dump of the entire ACPI device tree.
230  *
231  ******************************************************************************/
232 
233 void
234 MpEmitMappingInfo (
235     void)
236 {
237 
238     /* Mapfile option enabled? */
239 
240     if (!AslGbl_MapfileFlag)
241     {
242         return;
243     }
244 
245     if (!AslGbl_GpioList)
246     {
247         FlPrintFile (ASL_FILE_MAP_OUTPUT,
248             "\nNo GPIO devices found\n");
249     }
250 
251     if (!AslGbl_SerialList)
252     {
253         FlPrintFile (ASL_FILE_MAP_OUTPUT,
254             "\nNo Serial devices found (I2C/SPI/UART)\n");
255     }
256 
257     if (!AslGbl_GpioList && !AslGbl_SerialList)
258     {
259         return;
260     }
261 
262     /* Headers */
263 
264     FlPrintFile (ASL_FILE_MAP_OUTPUT, "\nResource Descriptor Connectivity Map\n");
265     FlPrintFile (ASL_FILE_MAP_OUTPUT,   "------------------------------------\n");
266 
267     /* Emit GPIO and Serial descriptors, then entire ACPI device tree */
268 
269     MpEmitGpioInfo ();
270     MpEmitSerialInfo ();
271     MpEmitDeviceTree ();
272 
273     /* Clear the lists - no need to free memory here */
274 
275     AslGbl_SerialList = NULL;
276     AslGbl_GpioList = NULL;
277 }
278 
279 
280 /*******************************************************************************
281  *
282  * FUNCTION:    MpEmitGpioInfo
283  *
284  * PARAMETERS:  None
285  *
286  * RETURN:      None
287  *
288  * DESCRIPTION: Emit the info about all GPIO devices found during the
289  *              compile or disassembly.
290  *
291  ******************************************************************************/
292 
293 static void
294 MpEmitGpioInfo (
295     void)
296 {
297     ACPI_GPIO_INFO          *Info;
298     char                    *Type;
299     char                    *PrevDeviceName = NULL;
300     const char              *Direction;
301     const char              *Polarity;
302     char                    *ParentPathname;
303     const char              *Description;
304     char                    *HidString;
305     const AH_DEVICE_ID      *HidInfo;
306 
307 
308     /* Walk the GPIO descriptor list */
309 
310     Info = AslGbl_GpioList;
311     while (Info)
312     {
313         HidString = MpGetHidViaNamestring (Info->DeviceName);
314 
315         /* Print header info for the controller itself */
316 
317         if (!PrevDeviceName ||
318             strcmp (PrevDeviceName, Info->DeviceName))
319         {
320             FlPrintFile (ASL_FILE_MAP_OUTPUT,
321                 "\n\nGPIO Controller:  %-8s  %-28s",
322                 HidString, Info->DeviceName);
323 
324             HidInfo = AcpiAhMatchHardwareId (HidString);
325             if (HidInfo)
326             {
327                 FlPrintFile (ASL_FILE_MAP_OUTPUT, "  // %s",
328                     HidInfo->Description);
329             }
330 
331             FlPrintFile (ASL_FILE_MAP_OUTPUT,
332                 "\n\nPin   Type     Direction    Polarity"
333                 "    Dest _HID  Destination\n");
334         }
335 
336         PrevDeviceName = Info->DeviceName;
337 
338         /* Setup various strings based upon the type (GpioInt or GpioIo) */
339 
340         switch (Info->Type)
341         {
342         case AML_RESOURCE_GPIO_TYPE_INT:
343 
344             Type = "GpioInt";
345             Direction = "-Interrupt-";
346             Polarity = PolarityDecode[Info->Polarity];
347             break;
348 
349         case AML_RESOURCE_GPIO_TYPE_IO:
350 
351             Type = "GpioIo ";
352             Direction = DirectionDecode[Info->Direction];
353             Polarity = "          ";
354             break;
355 
356         default:
357             continue;
358         }
359 
360         /* Emit the GPIO info */
361 
362         FlPrintFile (ASL_FILE_MAP_OUTPUT, "%4.4X  %s  %s  %s  ",
363             Info->PinNumber, Type, Direction, Polarity);
364 
365         ParentPathname = NULL;
366         HidString = MpGetConnectionInfo (Info->Op, Info->PinIndex,
367             &Info->TargetNode, &ParentPathname);
368         if (HidString)
369         {
370             /*
371              * This is a Connection() field
372              * Attempt to find all references to the field.
373              */
374             FlPrintFile (ASL_FILE_MAP_OUTPUT, "%8s   %-28s",
375                 HidString, ParentPathname);
376 
377             MpXrefDevices (Info);
378         }
379         else
380         {
381             /*
382              * For Devices, attempt to get the _HID description string.
383              * Failing that (many _HIDs are not recognized), attempt to
384              * get the _DDN description string.
385              */
386             HidString = MpGetParentDeviceHid (Info->Op, &Info->TargetNode,
387                 &ParentPathname);
388 
389             FlPrintFile (ASL_FILE_MAP_OUTPUT, "%8s   %-28s",
390                 HidString, ParentPathname);
391 
392             /* Get the _HID description or _DDN string */
393 
394             HidInfo = AcpiAhMatchHardwareId (HidString);
395             if (HidInfo)
396             {
397                 FlPrintFile (ASL_FILE_MAP_OUTPUT, "  // %s",
398                     HidInfo->Description);
399             }
400             else if ((Description = MpGetDdnValue (ParentPathname)))
401             {
402                 FlPrintFile (ASL_FILE_MAP_OUTPUT, "  // %s (_DDN)",
403                     Description);
404             }
405         }
406 
407         FlPrintFile (ASL_FILE_MAP_OUTPUT, "\n");
408         ACPI_FREE (ParentPathname);
409         Info = Info->Next;
410     }
411 }
412 
413 
414 /*******************************************************************************
415  *
416  * FUNCTION:    MpEmitSerialInfo
417  *
418  * PARAMETERS:  None
419  *
420  * RETURN:      None
421  *
422  * DESCRIPTION: Emit the info about all Serial devices found during the
423  *              compile or disassembly.
424  *
425  ******************************************************************************/
426 
427 static void
428 MpEmitSerialInfo (
429     void)
430 {
431     ACPI_SERIAL_INFO        *Info;
432     char                    *Type;
433     char                    *ParentPathname;
434     char                    *PrevDeviceName = NULL;
435     char                    *HidString;
436     const AH_DEVICE_ID      *HidInfo;
437     const char              *Description;
438     AML_RESOURCE            *Resource;
439 
440 
441     /* Walk the constructed serial descriptor list */
442 
443     Info = AslGbl_SerialList;
444     while (Info)
445     {
446         Resource = Info->Resource;
447         switch (Resource->CommonSerialBus.Type)
448         {
449         case AML_RESOURCE_I2C_SERIALBUSTYPE:
450             Type = "I2C ";
451             break;
452 
453         case AML_RESOURCE_SPI_SERIALBUSTYPE:
454             Type = "SPI ";
455             break;
456 
457         case AML_RESOURCE_UART_SERIALBUSTYPE:
458             Type = "UART";
459             break;
460 
461         default:
462             Type = "UNKN";
463             break;
464         }
465 
466         HidString = MpGetHidViaNamestring (Info->DeviceName);
467 
468         /* Print header info for the controller itself */
469 
470         if (!PrevDeviceName ||
471             strcmp (PrevDeviceName, Info->DeviceName))
472         {
473             FlPrintFile (ASL_FILE_MAP_OUTPUT, "\n\n%s Controller:  ",
474                 Type);
475             FlPrintFile (ASL_FILE_MAP_OUTPUT, "%-8s  %-28s",
476                 HidString, Info->DeviceName);
477 
478             HidInfo = AcpiAhMatchHardwareId (HidString);
479             if (HidInfo)
480             {
481                 FlPrintFile (ASL_FILE_MAP_OUTPUT, "  // %s",
482                     HidInfo->Description);
483             }
484 
485             FlPrintFile (ASL_FILE_MAP_OUTPUT, "\n\n");
486             FlPrintFile (ASL_FILE_MAP_OUTPUT,
487                 "Type  Address   Speed      Dest _HID  Destination\n");
488         }
489 
490         PrevDeviceName = Info->DeviceName;
491 
492         FlPrintFile (ASL_FILE_MAP_OUTPUT, "%s   %4.4X    %8.8X    ",
493             Type, Info->Address, Info->Speed);
494 
495         ParentPathname = NULL;
496         HidString = MpGetConnectionInfo (Info->Op, 0, &Info->TargetNode,
497             &ParentPathname);
498         if (HidString)
499         {
500             /*
501              * This is a Connection() field
502              * Attempt to find all references to the field.
503              */
504             FlPrintFile (ASL_FILE_MAP_OUTPUT, "%8s   %-28s",
505                 HidString, ParentPathname);
506         }
507         else
508         {
509             /* Normal resource template */
510 
511             HidString = MpGetParentDeviceHid (Info->Op, &Info->TargetNode,
512                 &ParentPathname);
513             FlPrintFile (ASL_FILE_MAP_OUTPUT, "%8s   %-28s",
514                 HidString, ParentPathname);
515 
516             /* Get the _HID description or _DDN string */
517 
518             HidInfo = AcpiAhMatchHardwareId (HidString);
519             if (HidInfo)
520             {
521                 FlPrintFile (ASL_FILE_MAP_OUTPUT, "  // %s",
522                     HidInfo->Description);
523             }
524             else if ((Description = MpGetDdnValue (ParentPathname)))
525             {
526                 FlPrintFile (ASL_FILE_MAP_OUTPUT, "  // %s (_DDN)",
527                     Description);
528             }
529         }
530 
531         FlPrintFile (ASL_FILE_MAP_OUTPUT, "\n");
532         ACPI_FREE (ParentPathname);
533         Info = Info->Next;
534     }
535 }
536 
537 
538 /*******************************************************************************
539  *
540  * FUNCTION:    MpEmitDeviceTree
541  *
542  * PARAMETERS:  None
543  *
544  * RETURN:      None
545  *
546  * DESCRIPTION: Emit information about all devices within the ACPI namespace.
547  *
548  ******************************************************************************/
549 
550 static void
551 MpEmitDeviceTree (
552     void)
553 {
554 
555     FlPrintFile (ASL_FILE_MAP_OUTPUT, "\n\nACPI Device Tree\n");
556     FlPrintFile (ASL_FILE_MAP_OUTPUT,     "----------------\n\n");
557 
558     FlPrintFile (ASL_FILE_MAP_OUTPUT, "Device Pathname                   "
559         "_HID      Description\n\n");
560 
561     /* Walk the namespace from the root */
562 
563     (void) AcpiNsWalkNamespace (ACPI_TYPE_DEVICE, ACPI_ROOT_OBJECT,
564         ACPI_UINT32_MAX, FALSE, MpEmitOneDevice, NULL, NULL, NULL);
565 }
566 
567 
568 /*******************************************************************************
569  *
570  * FUNCTION:    MpEmitOneDevice
571  *
572  * PARAMETERS:  ACPI_NAMESPACE_WALK callback
573  *
574  * RETURN:      Status
575  *
576  * DESCRIPTION: Emit information about one ACPI device in the namespace. Used
577  *              during dump of all device objects within the namespace.
578  *
579  ******************************************************************************/
580 
581 static ACPI_STATUS
582 MpEmitOneDevice (
583     ACPI_HANDLE             ObjHandle,
584     UINT32                  NestingLevel,
585     void                    *Context,
586     void                    **ReturnValue)
587 {
588     char                    *DevicePathname;
589     char                    *DdnString;
590     char                    *HidString;
591     const AH_DEVICE_ID      *HidInfo;
592 
593 
594     /* Device pathname */
595 
596     DevicePathname = AcpiNsGetExternalPathname (
597         ACPI_CAST_PTR (ACPI_NAMESPACE_NODE, ObjHandle));
598 
599     FlPrintFile (ASL_FILE_MAP_OUTPUT, "%-32s", DevicePathname);
600 
601     /* _HID or _DDN */
602 
603     HidString = MpGetHidValue (
604         ACPI_CAST_PTR (ACPI_NAMESPACE_NODE, ObjHandle));
605     FlPrintFile (ASL_FILE_MAP_OUTPUT, "%8s", HidString);
606 
607     HidInfo = AcpiAhMatchHardwareId (HidString);
608     if (HidInfo)
609     {
610         FlPrintFile (ASL_FILE_MAP_OUTPUT, "    // %s",
611             HidInfo->Description);
612     }
613     else if ((DdnString = MpGetDdnValue (DevicePathname)))
614     {
615         FlPrintFile (ASL_FILE_MAP_OUTPUT, "    // %s (_DDN)", DdnString);
616     }
617 
618     FlPrintFile (ASL_FILE_MAP_OUTPUT, "\n");
619     ACPI_FREE (DevicePathname);
620     return (AE_OK);
621 }
622 
623 
624 /*******************************************************************************
625  *
626  * FUNCTION:    MpXrefDevices
627  *
628  * PARAMETERS:  Info                    - A GPIO Info block
629  *
630  * RETURN:      None
631  *
632  * DESCRIPTION: Cross-reference the parse tree and find all references to the
633  *              specified GPIO device.
634  *
635  ******************************************************************************/
636 
637 static void
638 MpXrefDevices (
639     ACPI_GPIO_INFO          *Info)
640 {
641 
642     /* Walk the entire parse tree */
643 
644     TrWalkParseTree (AslGbl_ParseTreeRoot, ASL_WALK_VISIT_DOWNWARD,
645         MpNamespaceXrefBegin, NULL, Info);
646 
647     if (!Info->References)
648     {
649         FlPrintFile (ASL_FILE_MAP_OUTPUT, "  // **** No references in table");
650     }
651 }
652 
653 
654 /*******************************************************************************
655  *
656  * FUNCTION:    MpNamespaceXrefBegin
657  *
658  * PARAMETERS:  WALK_PARSE_TREE callback
659  *
660  * RETURN:      Status
661  *
662  * DESCRIPTION: Walk parse tree callback used to cross-reference GPIO pins.
663  *
664  ******************************************************************************/
665 
666 static ACPI_STATUS
667 MpNamespaceXrefBegin (
668     ACPI_PARSE_OBJECT       *Op,
669     UINT32                  Level,
670     void                    *Context)
671 {
672     ACPI_GPIO_INFO          *Info = ACPI_CAST_PTR (ACPI_GPIO_INFO, Context);
673     const ACPI_OPCODE_INFO  *OpInfo;
674     char                    *DevicePathname;
675     ACPI_PARSE_OBJECT       *ParentOp;
676     char                    *HidString;
677 
678 
679     ACPI_FUNCTION_TRACE_PTR (MpNamespaceXrefBegin, Op);
680 
681     /*
682      * If this node is the actual declaration of a name
683      * [such as the XXXX name in "Method (XXXX)"],
684      * we are not interested in it here. We only care about names that
685      * are references to other objects within the namespace and the
686      * parent objects of name declarations
687      */
688     if (Op->Asl.CompileFlags & OP_IS_NAME_DECLARATION)
689     {
690         return (AE_OK);
691     }
692 
693     /* We are only interested in opcodes that have an associated name */
694 
695     OpInfo = AcpiPsGetOpcodeInfo (Op->Asl.AmlOpcode);
696 
697     if ((OpInfo->Flags & AML_NAMED) ||
698         (OpInfo->Flags & AML_CREATE))
699     {
700         return (AE_OK);
701     }
702 
703     if ((Op->Asl.ParseOpcode != PARSEOP_NAMESTRING) &&
704         (Op->Asl.ParseOpcode != PARSEOP_NAMESEG)    &&
705         (Op->Asl.ParseOpcode != PARSEOP_METHODCALL))
706     {
707         return (AE_OK);
708     }
709 
710     if (!Op->Asl.Node)
711     {
712         return (AE_OK);
713     }
714 
715     ParentOp = Op->Asl.Parent;
716     if (ParentOp->Asl.ParseOpcode == PARSEOP_FIELD)
717     {
718         return (AE_OK);
719     }
720 
721     if (Op->Asl.Node == Info->TargetNode)
722     {
723         while (ParentOp && (!ParentOp->Asl.Node))
724         {
725             ParentOp = ParentOp->Asl.Parent;
726         }
727 
728         if (ParentOp)
729         {
730             DevicePathname = AcpiNsGetExternalPathname (
731                 ParentOp->Asl.Node);
732 
733             if (!Info->References)
734             {
735                 FlPrintFile (ASL_FILE_MAP_OUTPUT, "  // References:");
736             }
737 
738             HidString = MpGetHidViaNamestring (DevicePathname);
739 
740             FlPrintFile (ASL_FILE_MAP_OUTPUT, " %s [%s]",
741                 DevicePathname, HidString);
742 
743             Info->References++;
744 
745             ACPI_FREE (DevicePathname);
746         }
747     }
748 
749     return (AE_OK);
750 }
751