1 /******************************************************************************* 2 * 3 * Module Name: dbmethod - Debug commands for control methods 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 <contrib/dev/acpica/include/acpi.h> 153 #include <contrib/dev/acpica/include/accommon.h> 154 #include <contrib/dev/acpica/include/acdispat.h> 155 #include <contrib/dev/acpica/include/acnamesp.h> 156 #include <contrib/dev/acpica/include/acdebug.h> 157 #include <contrib/dev/acpica/include/acparser.h> 158 #include <contrib/dev/acpica/include/acpredef.h> 159 160 161 #define _COMPONENT ACPI_CA_DEBUGGER 162 ACPI_MODULE_NAME ("dbmethod") 163 164 /* Local prototypes */ 165 166 static ACPI_STATUS 167 AcpiDbWalkForExecute ( 168 ACPI_HANDLE ObjHandle, 169 UINT32 NestingLevel, 170 void *Context, 171 void **ReturnValue); 172 173 174 /******************************************************************************* 175 * 176 * FUNCTION: AcpiDbSetMethodBreakpoint 177 * 178 * PARAMETERS: Location - AML offset of breakpoint 179 * WalkState - Current walk info 180 * Op - Current Op (from parse walk) 181 * 182 * RETURN: None 183 * 184 * DESCRIPTION: Set a breakpoint in a control method at the specified 185 * AML offset 186 * 187 ******************************************************************************/ 188 189 void 190 AcpiDbSetMethodBreakpoint ( 191 char *Location, 192 ACPI_WALK_STATE *WalkState, 193 ACPI_PARSE_OBJECT *Op) 194 { 195 UINT32 Address; 196 UINT32 AmlOffset; 197 198 199 if (!Op) 200 { 201 AcpiOsPrintf ("There is no method currently executing\n"); 202 return; 203 } 204 205 /* Get and verify the breakpoint address */ 206 207 Address = strtoul (Location, NULL, 16); 208 AmlOffset = (UINT32) ACPI_PTR_DIFF (Op->Common.Aml, 209 WalkState->ParserState.AmlStart); 210 if (Address <= AmlOffset) 211 { 212 AcpiOsPrintf ("Breakpoint %X is beyond current address %X\n", 213 Address, AmlOffset); 214 } 215 216 /* Save breakpoint in current walk */ 217 218 WalkState->UserBreakpoint = Address; 219 AcpiOsPrintf ("Breakpoint set at AML offset %X\n", Address); 220 } 221 222 223 /******************************************************************************* 224 * 225 * FUNCTION: AcpiDbSetMethodCallBreakpoint 226 * 227 * PARAMETERS: Op - Current Op (from parse walk) 228 * 229 * RETURN: None 230 * 231 * DESCRIPTION: Set a breakpoint in a control method at the specified 232 * AML offset 233 * 234 ******************************************************************************/ 235 236 void 237 AcpiDbSetMethodCallBreakpoint ( 238 ACPI_PARSE_OBJECT *Op) 239 { 240 241 242 if (!Op) 243 { 244 AcpiOsPrintf ("There is no method currently executing\n"); 245 return; 246 } 247 248 AcpiGbl_StepToNextCall = TRUE; 249 } 250 251 252 /******************************************************************************* 253 * 254 * FUNCTION: AcpiDbSetMethodData 255 * 256 * PARAMETERS: TypeArg - L for local, A for argument 257 * IndexArg - which one 258 * ValueArg - Value to set. 259 * 260 * RETURN: None 261 * 262 * DESCRIPTION: Set a local or argument for the running control method. 263 * NOTE: only object supported is Number. 264 * 265 ******************************************************************************/ 266 267 void 268 AcpiDbSetMethodData ( 269 char *TypeArg, 270 char *IndexArg, 271 char *ValueArg) 272 { 273 char Type; 274 UINT32 Index; 275 UINT32 Value; 276 ACPI_WALK_STATE *WalkState; 277 ACPI_OPERAND_OBJECT *ObjDesc; 278 ACPI_STATUS Status; 279 ACPI_NAMESPACE_NODE *Node; 280 281 282 /* Validate TypeArg */ 283 284 AcpiUtStrupr (TypeArg); 285 Type = TypeArg[0]; 286 if ((Type != 'L') && 287 (Type != 'A') && 288 (Type != 'N')) 289 { 290 AcpiOsPrintf ("Invalid SET operand: %s\n", TypeArg); 291 return; 292 } 293 294 Value = strtoul (ValueArg, NULL, 16); 295 296 if (Type == 'N') 297 { 298 Node = AcpiDbConvertToNode (IndexArg); 299 if (!Node) 300 { 301 return; 302 } 303 304 if (Node->Type != ACPI_TYPE_INTEGER) 305 { 306 AcpiOsPrintf ("Can only set Integer nodes\n"); 307 return; 308 } 309 ObjDesc = Node->Object; 310 ObjDesc->Integer.Value = Value; 311 return; 312 } 313 314 /* Get the index and value */ 315 316 Index = strtoul (IndexArg, NULL, 16); 317 318 WalkState = AcpiDsGetCurrentWalkState (AcpiGbl_CurrentWalkList); 319 if (!WalkState) 320 { 321 AcpiOsPrintf ("There is no method currently executing\n"); 322 return; 323 } 324 325 /* Create and initialize the new object */ 326 327 ObjDesc = AcpiUtCreateIntegerObject ((UINT64) Value); 328 if (!ObjDesc) 329 { 330 AcpiOsPrintf ("Could not create an internal object\n"); 331 return; 332 } 333 334 /* Store the new object into the target */ 335 336 switch (Type) 337 { 338 case 'A': 339 340 /* Set a method argument */ 341 342 if (Index > ACPI_METHOD_MAX_ARG) 343 { 344 AcpiOsPrintf ("Arg%u - Invalid argument name\n", 345 Index); 346 goto Cleanup; 347 } 348 349 Status = AcpiDsStoreObjectToLocal (ACPI_REFCLASS_ARG, 350 Index, ObjDesc, WalkState); 351 if (ACPI_FAILURE (Status)) 352 { 353 goto Cleanup; 354 } 355 356 ObjDesc = WalkState->Arguments[Index].Object; 357 358 AcpiOsPrintf ("Arg%u: ", Index); 359 AcpiDbDisplayInternalObject (ObjDesc, WalkState); 360 break; 361 362 case 'L': 363 364 /* Set a method local */ 365 366 if (Index > ACPI_METHOD_MAX_LOCAL) 367 { 368 AcpiOsPrintf ("Local%u - Invalid local variable name\n", 369 Index); 370 goto Cleanup; 371 } 372 373 Status = AcpiDsStoreObjectToLocal (ACPI_REFCLASS_LOCAL, 374 Index, ObjDesc, WalkState); 375 if (ACPI_FAILURE (Status)) 376 { 377 goto Cleanup; 378 } 379 380 ObjDesc = WalkState->LocalVariables[Index].Object; 381 382 AcpiOsPrintf ("Local%u: ", Index); 383 AcpiDbDisplayInternalObject (ObjDesc, WalkState); 384 break; 385 386 default: 387 388 break; 389 } 390 391 Cleanup: 392 AcpiUtRemoveReference (ObjDesc); 393 } 394 395 396 /******************************************************************************* 397 * 398 * FUNCTION: AcpiDbDisassembleAml 399 * 400 * PARAMETERS: Statements - Number of statements to disassemble 401 * Op - Current Op (from parse walk) 402 * 403 * RETURN: None 404 * 405 * DESCRIPTION: Display disassembled AML (ASL) starting from Op for the number 406 * of statements specified. 407 * 408 ******************************************************************************/ 409 410 void 411 AcpiDbDisassembleAml ( 412 char *Statements, 413 ACPI_PARSE_OBJECT *Op) 414 { 415 UINT32 NumStatements = 8; 416 417 418 if (!Op) 419 { 420 AcpiOsPrintf ("There is no method currently executing\n"); 421 return; 422 } 423 424 if (Statements) 425 { 426 NumStatements = strtoul (Statements, NULL, 0); 427 } 428 429 #ifdef ACPI_DISASSEMBLER 430 AcpiDmDisassemble (NULL, Op, NumStatements); 431 #endif 432 } 433 434 435 /******************************************************************************* 436 * 437 * FUNCTION: AcpiDbDisassembleMethod 438 * 439 * PARAMETERS: Name - Name of control method 440 * 441 * RETURN: None 442 * 443 * DESCRIPTION: Display disassembled AML (ASL) starting from Op for the number 444 * of statements specified. 445 * 446 ******************************************************************************/ 447 448 ACPI_STATUS 449 AcpiDbDisassembleMethod ( 450 char *Name) 451 { 452 ACPI_STATUS Status; 453 ACPI_PARSE_OBJECT *Op; 454 ACPI_WALK_STATE *WalkState; 455 ACPI_OPERAND_OBJECT *ObjDesc; 456 ACPI_NAMESPACE_NODE *Method; 457 458 459 Method = AcpiDbConvertToNode (Name); 460 if (!Method) 461 { 462 return (AE_BAD_PARAMETER); 463 } 464 465 if (Method->Type != ACPI_TYPE_METHOD) 466 { 467 ACPI_ERROR ((AE_INFO, "%s (%s): Object must be a control method", 468 Name, AcpiUtGetTypeName (Method->Type))); 469 return (AE_BAD_PARAMETER); 470 } 471 472 ObjDesc = Method->Object; 473 474 Op = AcpiPsCreateScopeOp (ObjDesc->Method.AmlStart); 475 if (!Op) 476 { 477 return (AE_NO_MEMORY); 478 } 479 480 /* Create and initialize a new walk state */ 481 482 WalkState = AcpiDsCreateWalkState (0, Op, NULL, NULL); 483 if (!WalkState) 484 { 485 return (AE_NO_MEMORY); 486 } 487 488 Status = AcpiDsInitAmlWalk (WalkState, Op, NULL, 489 ObjDesc->Method.AmlStart, 490 ObjDesc->Method.AmlLength, NULL, ACPI_IMODE_LOAD_PASS1); 491 if (ACPI_FAILURE (Status)) 492 { 493 return (Status); 494 } 495 496 Status = AcpiUtAllocateOwnerId (&ObjDesc->Method.OwnerId); 497 WalkState->OwnerId = ObjDesc->Method.OwnerId; 498 499 /* Push start scope on scope stack and make it current */ 500 501 Status = AcpiDsScopeStackPush (Method, 502 Method->Type, WalkState); 503 if (ACPI_FAILURE (Status)) 504 { 505 return (Status); 506 } 507 508 /* Parse the entire method AML including deferred operators */ 509 510 WalkState->ParseFlags &= ~ACPI_PARSE_DELETE_TREE; 511 WalkState->ParseFlags |= ACPI_PARSE_DISASSEMBLE; 512 513 Status = AcpiPsParseAml (WalkState); 514 515 #ifdef ACPI_DISASSEMBLER 516 (void) AcpiDmParseDeferredOps (Op); 517 518 /* Now we can disassemble the method */ 519 520 AcpiGbl_DmOpt_Verbose = FALSE; 521 AcpiDmDisassemble (NULL, Op, 0); 522 AcpiGbl_DmOpt_Verbose = TRUE; 523 #endif 524 525 AcpiPsDeleteParseTree (Op); 526 527 /* Method cleanup */ 528 529 AcpiNsDeleteNamespaceSubtree (Method); 530 AcpiNsDeleteNamespaceByOwner (ObjDesc->Method.OwnerId); 531 AcpiUtReleaseOwnerId (&ObjDesc->Method.OwnerId); 532 return (AE_OK); 533 } 534 535 536 /******************************************************************************* 537 * 538 * FUNCTION: AcpiDbWalkForExecute 539 * 540 * PARAMETERS: Callback from WalkNamespace 541 * 542 * RETURN: Status 543 * 544 * DESCRIPTION: Batch execution module. Currently only executes predefined 545 * ACPI names. 546 * 547 ******************************************************************************/ 548 549 static ACPI_STATUS 550 AcpiDbWalkForExecute ( 551 ACPI_HANDLE ObjHandle, 552 UINT32 NestingLevel, 553 void *Context, 554 void **ReturnValue) 555 { 556 ACPI_NAMESPACE_NODE *Node = (ACPI_NAMESPACE_NODE *) ObjHandle; 557 ACPI_DB_EXECUTE_WALK *Info = (ACPI_DB_EXECUTE_WALK *) Context; 558 ACPI_BUFFER ReturnObj; 559 ACPI_STATUS Status; 560 char *Pathname; 561 UINT32 i; 562 ACPI_DEVICE_INFO *ObjInfo; 563 ACPI_OBJECT_LIST ParamObjects; 564 ACPI_OBJECT Params[ACPI_METHOD_NUM_ARGS]; 565 const ACPI_PREDEFINED_INFO *Predefined; 566 567 568 Predefined = AcpiUtMatchPredefinedMethod (Node->Name.Ascii); 569 if (!Predefined) 570 { 571 return (AE_OK); 572 } 573 574 if (Node->Type == ACPI_TYPE_LOCAL_SCOPE) 575 { 576 return (AE_OK); 577 } 578 579 Pathname = AcpiNsGetExternalPathname (Node); 580 if (!Pathname) 581 { 582 return (AE_OK); 583 } 584 585 /* Get the object info for number of method parameters */ 586 587 Status = AcpiGetObjectInfo (ObjHandle, &ObjInfo); 588 if (ACPI_FAILURE (Status)) 589 { 590 ACPI_FREE (Pathname); 591 return (Status); 592 } 593 594 ParamObjects.Pointer = NULL; 595 ParamObjects.Count = 0; 596 597 if (ObjInfo->Type == ACPI_TYPE_METHOD) 598 { 599 /* Setup default parameters */ 600 601 for (i = 0; i < ObjInfo->ParamCount; i++) 602 { 603 Params[i].Type = ACPI_TYPE_INTEGER; 604 Params[i].Integer.Value = 1; 605 } 606 607 ParamObjects.Pointer = Params; 608 ParamObjects.Count = ObjInfo->ParamCount; 609 } 610 611 ACPI_FREE (ObjInfo); 612 ReturnObj.Pointer = NULL; 613 ReturnObj.Length = ACPI_ALLOCATE_BUFFER; 614 615 /* Do the actual method execution */ 616 617 AcpiGbl_MethodExecuting = TRUE; 618 619 Status = AcpiEvaluateObject (Node, NULL, &ParamObjects, &ReturnObj); 620 621 AcpiOsPrintf ("%-32s returned %s\n", Pathname, AcpiFormatException (Status)); 622 AcpiGbl_MethodExecuting = FALSE; 623 ACPI_FREE (Pathname); 624 625 /* Ignore status from method execution */ 626 627 Status = AE_OK; 628 629 /* Update count, check if we have executed enough methods */ 630 631 Info->Count++; 632 if (Info->Count >= Info->MaxCount) 633 { 634 Status = AE_CTRL_TERMINATE; 635 } 636 637 return (Status); 638 } 639 640 641 /******************************************************************************* 642 * 643 * FUNCTION: AcpiDbEvaluatePredefinedNames 644 * 645 * PARAMETERS: None 646 * 647 * RETURN: None 648 * 649 * DESCRIPTION: Namespace batch execution. Execute predefined names in the 650 * namespace, up to the max count, if specified. 651 * 652 ******************************************************************************/ 653 654 void 655 AcpiDbEvaluatePredefinedNames ( 656 void) 657 { 658 ACPI_DB_EXECUTE_WALK Info; 659 660 661 Info.Count = 0; 662 Info.MaxCount = ACPI_UINT32_MAX; 663 664 /* Search all nodes in namespace */ 665 666 (void) AcpiWalkNamespace (ACPI_TYPE_ANY, ACPI_ROOT_OBJECT, ACPI_UINT32_MAX, 667 AcpiDbWalkForExecute, NULL, (void *) &Info, NULL); 668 669 AcpiOsPrintf ("Evaluated %u predefined names in the namespace\n", Info.Count); 670 } 671