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