drivers/acpi/compiler/aslmaputils.c

   1 /******************************************************************************
   2  *
   3  * Module Name: aslmaputils - Utilities for 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 - 2015, 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 #include "acpi.h"
 117 #include "accommon.h"
 118 #include "acapps.h"
 119 #include "aslcompiler.h"
 120 #include "aslcompiler.y.h"
 121 #include "acinterp.h"
 122 #include "acnamesp.h"
 123 #include "amlcode.h"
 124
 125 /* This module used for application-level code only */
 126
 127 #define _COMPONENT          ACPI_COMPILER
 128         ACPI_MODULE_NAME    ("aslmaputils")
 129
 130
 131 /*******************************************************************************
 132  *
 133  * FUNCTION:    MpGetHidFromParseTree
 134  *
 135  * PARAMETERS:  HidNode             - Node for a _HID object
 136  *
 137  * RETURN:      An _HID string value. Automatically converts _HID integers
 138  *              to strings. Never NULL.
 139  *
 140  * DESCRIPTION: Extract a _HID value from the parse tree, not the namespace.
 141  *              Used when a fully initialized namespace is not available.
 142  *
 143  ******************************************************************************/
 144
 145 char *
 146 MpGetHidFromParseTree (
 147     ACPI_NAMESPACE_NODE     *HidNode)
 148 {
 149     ACPI_PARSE_OBJECT       *Op;
 150     ACPI_PARSE_OBJECT       *Arg;
 151     char                    *HidString;
 152
 153
 154     Op = HidNode->Op;
 155
 156     switch (Op->Asl.ParseOpcode)
 157     {
 158     case PARSEOP_NAME:
 159
 160         Arg = Op->Asl.Child;  /* Get the NameSeg/NameString node */
 161         Arg = Arg->Asl.Next;  /* First peer is the object to be associated with the name */
 162
 163         switch (Arg->Asl.ParseOpcode)
 164         {
 165         case PARSEOP_STRING_LITERAL:
 166
 167             return (Arg->Asl.Value.String);
 168
 169         case PARSEOP_INTEGER:
 170
 171             /* Convert EISAID to a string */
 172
 173             HidString = UtStringCacheCalloc (ACPI_EISAID_STRING_SIZE);
 174             AcpiExEisaIdToString (HidString, Arg->Asl.Value.Integer);
 175             return (HidString);
 176
 177         default:
 178
 179             return ("UNKNOWN");
 180         }
 181
 182     default:
 183         return ("-No HID-");
 184     }
 185 }
 186
 187
 188 /*******************************************************************************
 189  *
 190  * FUNCTION:    MpGetHidValue
 191  *
 192  * PARAMETERS:  DeviceNode          - Node for parent device
 193  *
 194  * RETURN:      An _HID string value. Automatically converts _HID integers
 195  *              to strings. Never NULL.
 196  *
 197  * DESCRIPTION: Extract _HID value from within a device scope. Does not
 198  *              actually execute a method, just gets the string or integer
 199  *              value for the _HID.
 200  *
 201  ******************************************************************************/
 202
 203 char *
 204 MpGetHidValue (
 205     ACPI_NAMESPACE_NODE     *DeviceNode)
 206 {
 207     ACPI_NAMESPACE_NODE     *HidNode;
 208     char                    *HidString;
 209     ACPI_STATUS             Status;
 210
 211
 212     Status = AcpiNsGetNode (DeviceNode, METHOD_NAME__HID,
 213         ACPI_NS_NO_UPSEARCH, &HidNode);
 214     if (ACPI_FAILURE (Status))
 215     {
 216         goto ErrorExit;
 217     }
 218
 219     /* If only partial namespace, get the _HID from the parse tree */
 220
 221     if (!HidNode->Object)
 222     {
 223         return (MpGetHidFromParseTree (HidNode));
 224     }
 225
 226     /* Handle the different _HID flavors */
 227
 228     switch (HidNode->Type)
 229     {
 230     case ACPI_TYPE_STRING:
 231
 232         return (HidNode->Object->String.Pointer);
 233
 234     case ACPI_TYPE_INTEGER:
 235
 236         /* Convert EISAID to a string */
 237
 238         HidString = UtStringCacheCalloc (ACPI_EISAID_STRING_SIZE);
 239         AcpiExEisaIdToString (HidString, HidNode->Object->Integer.Value);
 240         return (HidString);
 241
 242     case ACPI_TYPE_METHOD:
 243
 244         return ("-Method-");
 245
 246     default:
 247
 248         FlPrintFile (ASL_FILE_MAP_OUTPUT, "BAD HID TYPE: %u", HidNode->Type);
 249         break;
 250     }
 251
 252
 253 ErrorExit:
 254     return ("-No HID-");
 255 }
 256
 257
 258 /*******************************************************************************
 259  *
 260  * FUNCTION:    MpGetHidViaNamestring
 261  *
 262  * PARAMETERS:  DeviceName          - Namepath for parent device
 263  *
 264  * RETURN:      _HID string. Never NULL.
 265  *
 266  * DESCRIPTION: Get a _HID value via a device pathname (instead of just simply
 267  *              a device node.)
 268  *
 269  ******************************************************************************/
 270
 271 char *
 272 MpGetHidViaNamestring (
 273     char                    *DeviceName)
 274 {
 275     ACPI_NAMESPACE_NODE     *DeviceNode;
 276     ACPI_STATUS             Status;
 277
 278
 279     Status = AcpiNsGetNode (NULL, DeviceName, ACPI_NS_NO_UPSEARCH,
 280         &DeviceNode);
 281     if (ACPI_FAILURE (Status))
 282     {
 283         goto ErrorExit;
 284     }
 285
 286     return (MpGetHidValue (DeviceNode));
 287
 288
 289 ErrorExit:
 290     return ("-No HID-");
 291 }
 292
 293
 294 /*******************************************************************************
 295  *
 296  * FUNCTION:    MpGetParentDeviceHid
 297  *
 298  * PARAMETERS:  Op                      - Parse Op to be examined
 299  *              TargetNode              - Where the field node is returned
 300  *              ParentDeviceName        - Where the node path is returned
 301  *
 302  * RETURN:      _HID string. Never NULL.
 303  *
 304  * DESCRIPTION: Find the parent Device or Scope Op, get the full pathname to
 305  *              the parent, and get the _HID associated with the parent.
 306  *
 307  ******************************************************************************/
 308
 309 char *
 310 MpGetParentDeviceHid (
 311     ACPI_PARSE_OBJECT       *Op,
 312     ACPI_NAMESPACE_NODE     **TargetNode,
 313     char                    **ParentDeviceName)
 314 {
 315     ACPI_NAMESPACE_NODE     *DeviceNode;
 316
 317
 318     /* Find parent Device() or Scope() Op */
 319
 320     while (Op &&
 321         (Op->Asl.AmlOpcode != AML_DEVICE_OP) &&
 322         (Op->Asl.AmlOpcode != AML_SCOPE_OP))
 323     {
 324         Op = Op->Asl.Parent;
 325     }
 326
 327     if (!Op)
 328     {
 329         FlPrintFile (ASL_FILE_MAP_OUTPUT, " No_Parent_Device ");
 330         goto ErrorExit;
 331     }
 332
 333     /* Get the full pathname to the device and the _HID */
 334
 335     DeviceNode = Op->Asl.Node;
 336     if (!DeviceNode)
 337     {
 338         FlPrintFile (ASL_FILE_MAP_OUTPUT, " No_Device_Node ");
 339         goto ErrorExit;
 340     }
 341
 342     *ParentDeviceName = AcpiNsGetExternalPathname (DeviceNode);
 343     return (MpGetHidValue (DeviceNode));
 344
 345
 346 ErrorExit:
 347     return ("-No HID-");
 348 }
 349
 350
 351 /*******************************************************************************
 352  *
 353  * FUNCTION:    MpGetDdnValue
 354  *
 355  * PARAMETERS:  DeviceName          - Namepath for parent device
 356  *
 357  * RETURN:      _DDN description string. NULL on failure.
 358  *
 359  * DESCRIPTION: Execute the _DDN method for the device.
 360  *
 361  ******************************************************************************/
 362
 363 char *
 364 MpGetDdnValue (
 365     char                    *DeviceName)
 366 {
 367     ACPI_NAMESPACE_NODE     *DeviceNode;
 368     ACPI_NAMESPACE_NODE     *DdnNode;
 369     ACPI_STATUS             Status;
 370
 371
 372     Status = AcpiNsGetNode (NULL, DeviceName, ACPI_NS_NO_UPSEARCH,
 373         &DeviceNode);
 374     if (ACPI_FAILURE (Status))
 375     {
 376         goto ErrorExit;
 377     }
 378
 379     Status = AcpiNsGetNode (DeviceNode, METHOD_NAME__DDN, ACPI_NS_NO_UPSEARCH,
 380         &DdnNode);
 381     if (ACPI_FAILURE (Status))
 382     {
 383         goto ErrorExit;
 384     }
 385
 386     if ((DdnNode->Type != ACPI_TYPE_STRING) ||
 387         !DdnNode->Object)
 388     {
 389         goto ErrorExit;
 390     }
 391
 392     return (DdnNode->Object->String.Pointer);
 393
 394
 395 ErrorExit:
 396     return (NULL);
 397 }
 398
 399
 400 /*******************************************************************************
 401  *
 402  * FUNCTION:    MpGetConnectionInfo
 403  *
 404  * PARAMETERS:  Op                      - Parse Op to be examined
 405  *              PinIndex                - Index into GPIO PinList
 406  *              TargetNode              - Where the field node is returned
 407  *              TargetName              - Where the node path is returned
 408  *
 409  * RETURN:      A substitute _HID string, indicating that the name is actually
 410  *              a field. NULL if the Op does not refer to a Connection.
 411  *
 412  * DESCRIPTION: Get the Field Unit that corresponds to the PinIndex after
 413  *              a Connection() invocation.
 414  *
 415  ******************************************************************************/
 416
 417 char *
 418 MpGetConnectionInfo (
 419     ACPI_PARSE_OBJECT       *Op,
 420     UINT32                  PinIndex,
 421     ACPI_NAMESPACE_NODE     **TargetNode,
 422     char                    **TargetName)
 423 {
 424     ACPI_PARSE_OBJECT       *NextOp;
 425     UINT32                  i;
 426
 427
 428     /*
 429      * Handle Connection() here. Find the next named FieldUnit.
 430      * Note: we look at the ParseOpcode for the compiler, look
 431      * at the AmlOpcode for the disassembler.
 432      */
 433     if ((Op->Asl.AmlOpcode == AML_INT_CONNECTION_OP) ||
 434         (Op->Asl.ParseOpcode == PARSEOP_CONNECTION))
 435     {
 436         /* Find the correct field unit definition */
 437
 438         NextOp = Op;
 439         for (i = 0; i <= PinIndex;)
 440         {
 441             NextOp = NextOp->Asl.Next;
 442             while (NextOp &&
 443                 (NextOp->Asl.ParseOpcode != PARSEOP_NAMESEG) &&
 444                 (NextOp->Asl.AmlOpcode != AML_INT_NAMEDFIELD_OP))
 445             {
 446                 NextOp = NextOp->Asl.Next;
 447             }
 448
 449             if (!NextOp)
 450             {
 451                 return ("UNKNOWN");
 452             }
 453
 454             /* Add length of this field to the current pin index */
 455
 456             if (NextOp->Asl.ParseOpcode == PARSEOP_NAMESEG)
 457             {
 458                 i += (UINT32) NextOp->Asl.Child->Asl.Value.Integer;
 459             }
 460             else /* AML_INT_NAMEDFIELD_OP */
 461             {
 462                 i += (UINT32) NextOp->Asl.Value.Integer;
 463             }
 464         }
 465
 466         /* Return the node and pathname for the field unit */
 467
 468         *TargetNode = NextOp->Asl.Node;
 469         *TargetName = AcpiNsGetExternalPathname (*TargetNode);
 470         return ("-Field-");
 471     }
 472
 473     return (NULL);
 474 }