1 /******************************************************************************
3 * Module Name: aslmapoutput - Output/emit the resource descriptor/device maps
5 *****************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2017, Intel Corp.
12 * All rights reserved.
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
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
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;
37 * The above copyright and patent license is granted only if the following
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.
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
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
72 * 3.4. Intel retains all right, title, and interest in and to the Original
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.
80 * 4. Disclaimer and Export Compliance
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
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
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.
114 *****************************************************************************
116 * Alternatively, you may choose to be licensed under the terms of the
119 * Redistribution and use in source and binary forms, with or without
120 * modification, are permitted provided that the following conditions
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.
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.
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.
150 *****************************************************************************/
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>
162 /* This module used for application-level code only */
164 #define _COMPONENT ACPI_COMPILER
165 ACPI_MODULE_NAME ("aslmapoutput")
167 /* Local prototypes */
183 ACPI_HANDLE ObjHandle,
190 ACPI_GPIO_INFO *Info);
193 MpNamespaceXrefBegin (
194 ACPI_PARSE_OBJECT *Op,
199 /* Strings used to decode flag bits */
201 const char *DirectionDecode[] =
209 const char *PolarityDecode[] =
218 /*******************************************************************************
220 * FUNCTION: MpEmitMappingInfo
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.
231 ******************************************************************************/
238 /* Mapfile option enabled? */
240 if (!Gbl_MapfileFlag)
247 FlPrintFile (ASL_FILE_MAP_OUTPUT,
248 "\nNo GPIO devices found\n");
253 FlPrintFile (ASL_FILE_MAP_OUTPUT,
254 "\nNo Serial devices found (I2C/SPI/UART)\n");
257 if (!Gbl_GpioList && !Gbl_SerialList)
264 FlPrintFile (ASL_FILE_MAP_OUTPUT, "\nResource Descriptor Connectivity Map\n");
265 FlPrintFile (ASL_FILE_MAP_OUTPUT, "------------------------------------\n");
267 /* Emit GPIO and Serial descriptors, then entire ACPI device tree */
273 /* Clear the lists - no need to free memory here */
275 Gbl_SerialList = NULL;
280 /*******************************************************************************
282 * FUNCTION: MpEmitGpioInfo
288 * DESCRIPTION: Emit the info about all GPIO devices found during the
289 * compile or disassembly.
291 ******************************************************************************/
297 ACPI_GPIO_INFO *Info;
299 char *PrevDeviceName = NULL;
300 const char *Direction;
301 const char *Polarity;
302 char *ParentPathname;
303 const char *Description;
305 const AH_DEVICE_ID *HidInfo;
308 /* Walk the GPIO descriptor list */
313 HidString = MpGetHidViaNamestring (Info->DeviceName);
315 /* Print header info for the controller itself */
317 if (!PrevDeviceName ||
318 strcmp (PrevDeviceName, Info->DeviceName))
320 FlPrintFile (ASL_FILE_MAP_OUTPUT,
321 "\n\nGPIO Controller: %-8s %-28s",
322 HidString, Info->DeviceName);
324 HidInfo = AcpiAhMatchHardwareId (HidString);
327 FlPrintFile (ASL_FILE_MAP_OUTPUT, " // %s",
328 HidInfo->Description);
331 FlPrintFile (ASL_FILE_MAP_OUTPUT,
332 "\n\nPin Type Direction Polarity"
333 " Dest _HID Destination\n");
336 PrevDeviceName = Info->DeviceName;
338 /* Setup various strings based upon the type (GpioInt or GpioIo) */
342 case AML_RESOURCE_GPIO_TYPE_INT:
345 Direction = "-Interrupt-";
346 Polarity = PolarityDecode[Info->Polarity];
349 case AML_RESOURCE_GPIO_TYPE_IO:
352 Direction = DirectionDecode[Info->Direction];
360 /* Emit the GPIO info */
362 FlPrintFile (ASL_FILE_MAP_OUTPUT, "%4.4X %s %s %s ",
363 Info->PinNumber, Type, Direction, Polarity);
365 ParentPathname = NULL;
366 HidString = MpGetConnectionInfo (Info->Op, Info->PinIndex,
367 &Info->TargetNode, &ParentPathname);
371 * This is a Connection() field
372 * Attempt to find all references to the field.
374 FlPrintFile (ASL_FILE_MAP_OUTPUT, "%8s %-28s",
375 HidString, ParentPathname);
377 MpXrefDevices (Info);
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.
386 HidString = MpGetParentDeviceHid (Info->Op, &Info->TargetNode,
389 FlPrintFile (ASL_FILE_MAP_OUTPUT, "%8s %-28s",
390 HidString, ParentPathname);
392 /* Get the _HID description or _DDN string */
394 HidInfo = AcpiAhMatchHardwareId (HidString);
397 FlPrintFile (ASL_FILE_MAP_OUTPUT, " // %s",
398 HidInfo->Description);
400 else if ((Description = MpGetDdnValue (ParentPathname)))
402 FlPrintFile (ASL_FILE_MAP_OUTPUT, " // %s (_DDN)",
407 FlPrintFile (ASL_FILE_MAP_OUTPUT, "\n");
408 ACPI_FREE (ParentPathname);
414 /*******************************************************************************
416 * FUNCTION: MpEmitSerialInfo
422 * DESCRIPTION: Emit the info about all Serial devices found during the
423 * compile or disassembly.
425 ******************************************************************************/
431 ACPI_SERIAL_INFO *Info;
433 char *ParentPathname;
434 char *PrevDeviceName = NULL;
436 const AH_DEVICE_ID *HidInfo;
437 const char *Description;
438 AML_RESOURCE *Resource;
441 /* Walk the constructed serial descriptor list */
443 Info = Gbl_SerialList;
446 Resource = Info->Resource;
447 switch (Resource->CommonSerialBus.Type)
449 case AML_RESOURCE_I2C_SERIALBUSTYPE:
453 case AML_RESOURCE_SPI_SERIALBUSTYPE:
457 case AML_RESOURCE_UART_SERIALBUSTYPE:
466 HidString = MpGetHidViaNamestring (Info->DeviceName);
468 /* Print header info for the controller itself */
470 if (!PrevDeviceName ||
471 strcmp (PrevDeviceName, Info->DeviceName))
473 FlPrintFile (ASL_FILE_MAP_OUTPUT, "\n\n%s Controller: ",
475 FlPrintFile (ASL_FILE_MAP_OUTPUT, "%-8s %-28s",
476 HidString, Info->DeviceName);
478 HidInfo = AcpiAhMatchHardwareId (HidString);
481 FlPrintFile (ASL_FILE_MAP_OUTPUT, " // %s",
482 HidInfo->Description);
485 FlPrintFile (ASL_FILE_MAP_OUTPUT, "\n\n");
486 FlPrintFile (ASL_FILE_MAP_OUTPUT,
487 "Type Address Speed Dest _HID Destination\n");
490 PrevDeviceName = Info->DeviceName;
492 FlPrintFile (ASL_FILE_MAP_OUTPUT, "%s %4.4X %8.8X ",
493 Type, Info->Address, Info->Speed);
495 ParentPathname = NULL;
496 HidString = MpGetConnectionInfo (Info->Op, 0, &Info->TargetNode,
501 * This is a Connection() field
502 * Attempt to find all references to the field.
504 FlPrintFile (ASL_FILE_MAP_OUTPUT, "%8s %-28s",
505 HidString, ParentPathname);
509 /* Normal resource template */
511 HidString = MpGetParentDeviceHid (Info->Op, &Info->TargetNode,
513 FlPrintFile (ASL_FILE_MAP_OUTPUT, "%8s %-28s",
514 HidString, ParentPathname);
516 /* Get the _HID description or _DDN string */
518 HidInfo = AcpiAhMatchHardwareId (HidString);
521 FlPrintFile (ASL_FILE_MAP_OUTPUT, " // %s",
522 HidInfo->Description);
524 else if ((Description = MpGetDdnValue (ParentPathname)))
526 FlPrintFile (ASL_FILE_MAP_OUTPUT, " // %s (_DDN)",
531 FlPrintFile (ASL_FILE_MAP_OUTPUT, "\n");
532 ACPI_FREE (ParentPathname);
538 /*******************************************************************************
540 * FUNCTION: MpEmitDeviceTree
546 * DESCRIPTION: Emit information about all devices within the ACPI namespace.
548 ******************************************************************************/
555 FlPrintFile (ASL_FILE_MAP_OUTPUT, "\n\nACPI Device Tree\n");
556 FlPrintFile (ASL_FILE_MAP_OUTPUT, "----------------\n\n");
558 FlPrintFile (ASL_FILE_MAP_OUTPUT, "Device Pathname "
559 "_HID Description\n\n");
561 /* Walk the namespace from the root */
563 (void) AcpiNsWalkNamespace (ACPI_TYPE_DEVICE, ACPI_ROOT_OBJECT,
564 ACPI_UINT32_MAX, FALSE, MpEmitOneDevice, NULL, NULL, NULL);
568 /*******************************************************************************
570 * FUNCTION: MpEmitOneDevice
572 * PARAMETERS: ACPI_NAMESPACE_WALK callback
576 * DESCRIPTION: Emit information about one ACPI device in the namespace. Used
577 * during dump of all device objects within the namespace.
579 ******************************************************************************/
583 ACPI_HANDLE ObjHandle,
588 char *DevicePathname;
591 const AH_DEVICE_ID *HidInfo;
594 /* Device pathname */
596 DevicePathname = AcpiNsGetExternalPathname (
597 ACPI_CAST_PTR (ACPI_NAMESPACE_NODE, ObjHandle));
599 FlPrintFile (ASL_FILE_MAP_OUTPUT, "%-32s", DevicePathname);
603 HidString = MpGetHidValue (
604 ACPI_CAST_PTR (ACPI_NAMESPACE_NODE, ObjHandle));
605 FlPrintFile (ASL_FILE_MAP_OUTPUT, "%8s", HidString);
607 HidInfo = AcpiAhMatchHardwareId (HidString);
610 FlPrintFile (ASL_FILE_MAP_OUTPUT, " // %s",
611 HidInfo->Description);
613 else if ((DdnString = MpGetDdnValue (DevicePathname)))
615 FlPrintFile (ASL_FILE_MAP_OUTPUT, " // %s (_DDN)", DdnString);
618 FlPrintFile (ASL_FILE_MAP_OUTPUT, "\n");
619 ACPI_FREE (DevicePathname);
624 /*******************************************************************************
626 * FUNCTION: MpXrefDevices
628 * PARAMETERS: Info - A GPIO Info block
632 * DESCRIPTION: Cross-reference the parse tree and find all references to the
633 * specified GPIO device.
635 ******************************************************************************/
639 ACPI_GPIO_INFO *Info)
642 /* Walk the entire parse tree */
644 TrWalkParseTree (Gbl_ParseTreeRoot, ASL_WALK_VISIT_DOWNWARD,
645 MpNamespaceXrefBegin, NULL, Info);
647 if (!Info->References)
649 FlPrintFile (ASL_FILE_MAP_OUTPUT, " // **** No references in table");
654 /*******************************************************************************
656 * FUNCTION: MpNamespaceXrefBegin
658 * PARAMETERS: WALK_PARSE_TREE callback
662 * DESCRIPTION: Walk parse tree callback used to cross-reference GPIO pins.
664 ******************************************************************************/
667 MpNamespaceXrefBegin (
668 ACPI_PARSE_OBJECT *Op,
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;
679 ACPI_FUNCTION_TRACE_PTR (MpNamespaceXrefBegin, Op);
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
688 if (Op->Asl.CompileFlags & NODE_IS_NAME_DECLARATION)
693 /* We are only interested in opcodes that have an associated name */
695 OpInfo = AcpiPsGetOpcodeInfo (Op->Asl.AmlOpcode);
697 if ((OpInfo->Flags & AML_NAMED) ||
698 (OpInfo->Flags & AML_CREATE))
703 if ((Op->Asl.ParseOpcode != PARSEOP_NAMESTRING) &&
704 (Op->Asl.ParseOpcode != PARSEOP_NAMESEG) &&
705 (Op->Asl.ParseOpcode != PARSEOP_METHODCALL))
715 ParentOp = Op->Asl.Parent;
716 if (ParentOp->Asl.ParseOpcode == PARSEOP_FIELD)
721 if (Op->Asl.Node == Info->TargetNode)
723 while (ParentOp && (!ParentOp->Asl.Node))
725 ParentOp = ParentOp->Asl.Parent;
730 DevicePathname = AcpiNsGetExternalPathname (
733 if (!Info->References)
735 FlPrintFile (ASL_FILE_MAP_OUTPUT, " // References:");
738 HidString = MpGetHidViaNamestring (DevicePathname);
740 FlPrintFile (ASL_FILE_MAP_OUTPUT, " %s [%s]",
741 DevicePathname, HidString);
745 ACPI_FREE (DevicePathname);