LXR |
|
|
|
|||
File indexing completed on 2025-05-11 08:23:41
0001 /****************************************************************************** 0002 * 0003 * Name: acdebug.h - ACPI/AML debugger 0004 * 0005 *****************************************************************************/ 0006 0007 /****************************************************************************** 0008 * 0009 * 1. Copyright Notice 0010 * 0011 * Some or all of this work - Copyright (c) 1999 - 2024, Intel Corp. 0012 * All rights reserved. 0013 * 0014 * 2. License 0015 * 0016 * 2.1. This is your license from Intel Corp. under its intellectual property 0017 * rights. You may have additional license terms from the party that provided 0018 * you this software, covering your right to use that party's intellectual 0019 * property rights. 0020 * 0021 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a 0022 * copy of the source code appearing in this file ("Covered Code") an 0023 * irrevocable, perpetual, worldwide license under Intel's copyrights in the 0024 * base code distributed originally by Intel ("Original Intel Code") to copy, 0025 * make derivatives, distribute, use and display any portion of the Covered 0026 * Code in any form, with the right to sublicense such rights; and 0027 * 0028 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent 0029 * license (with the right to sublicense), under only those claims of Intel 0030 * patents that are infringed by the Original Intel Code, to make, use, sell, 0031 * offer to sell, and import the Covered Code and derivative works thereof 0032 * solely to the minimum extent necessary to exercise the above copyright 0033 * license, and in no event shall the patent license extend to any additions 0034 * to or modifications of the Original Intel Code. No other license or right 0035 * is granted directly or by implication, estoppel or otherwise; 0036 * 0037 * The above copyright and patent license is granted only if the following 0038 * conditions are met: 0039 * 0040 * 3. Conditions 0041 * 0042 * 3.1. Redistribution of Source with Rights to Further Distribute Source. 0043 * Redistribution of source code of any substantial portion of the Covered 0044 * Code or modification with rights to further distribute source must include 0045 * the above Copyright Notice, the above License, this list of Conditions, 0046 * and the following Disclaimer and Export Compliance provision. In addition, 0047 * Licensee must cause all Covered Code to which Licensee contributes to 0048 * contain a file documenting the changes Licensee made to create that Covered 0049 * Code and the date of any change. Licensee must include in that file the 0050 * documentation of any changes made by any predecessor Licensee. Licensee 0051 * must include a prominent statement that the modification is derived, 0052 * directly or indirectly, from Original Intel Code. 0053 * 0054 * 3.2. Redistribution of Source with no Rights to Further Distribute Source. 0055 * Redistribution of source code of any substantial portion of the Covered 0056 * Code or modification without rights to further distribute source must 0057 * include the following Disclaimer and Export Compliance provision in the 0058 * documentation and/or other materials provided with distribution. In 0059 * addition, Licensee may not authorize further sublicense of source of any 0060 * portion of the Covered Code, and must include terms to the effect that the 0061 * license from Licensee to its licensee is limited to the intellectual 0062 * property embodied in the software Licensee provides to its licensee, and 0063 * not to intellectual property embodied in modifications its licensee may 0064 * make. 0065 * 0066 * 3.3. Redistribution of Executable. Redistribution in executable form of any 0067 * substantial portion of the Covered Code or modification must reproduce the 0068 * above Copyright Notice, and the following Disclaimer and Export Compliance 0069 * provision in the documentation and/or other materials provided with the 0070 * distribution. 0071 * 0072 * 3.4. Intel retains all right, title, and interest in and to the Original 0073 * Intel Code. 0074 * 0075 * 3.5. Neither the name Intel nor any other trademark owned or controlled by 0076 * Intel shall be used in advertising or otherwise to promote the sale, use or 0077 * other dealings in products derived from or relating to the Covered Code 0078 * without prior written authorization from Intel. 0079 * 0080 * 4. Disclaimer and Export Compliance 0081 * 0082 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED 0083 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE 0084 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE, 0085 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY 0086 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY 0087 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A 0088 * PARTICULAR PURPOSE. 0089 * 0090 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES 0091 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR 0092 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT, 0093 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY 0094 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL 0095 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS 0096 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY 0097 * LIMITED REMEDY. 0098 * 0099 * 4.3. Licensee shall not export, either directly or indirectly, any of this 0100 * software or system incorporating such software without first obtaining any 0101 * required license or other approval from the U. S. Department of Commerce or 0102 * any other agency or department of the United States Government. In the 0103 * event Licensee exports any such software from the United States or 0104 * re-exports any such software from a foreign destination, Licensee shall 0105 * ensure that the distribution and export/re-export of the software is in 0106 * compliance with all laws, regulations, orders, or other restrictions of the 0107 * U.S. Export Administration Regulations. Licensee agrees that neither it nor 0108 * any of its subsidiaries will export/re-export any technical data, process, 0109 * software, or service, directly or indirectly, to any country for which the 0110 * United States government or any agency thereof requires an export license, 0111 * other governmental approval, or letter of assurance, without first obtaining 0112 * such license, approval or letter. 0113 * 0114 ***************************************************************************** 0115 * 0116 * Alternatively, you may choose to be licensed under the terms of the 0117 * following license: 0118 * 0119 * Redistribution and use in source and binary forms, with or without 0120 * modification, are permitted provided that the following conditions 0121 * are met: 0122 * 1. Redistributions of source code must retain the above copyright 0123 * notice, this list of conditions, and the following disclaimer, 0124 * without modification. 0125 * 2. Redistributions in binary form must reproduce at minimum a disclaimer 0126 * substantially similar to the "NO WARRANTY" disclaimer below 0127 * ("Disclaimer") and any redistribution must be conditioned upon 0128 * including a substantially similar Disclaimer requirement for further 0129 * binary redistribution. 0130 * 3. Neither the names of the above-listed copyright holders nor the names 0131 * of any contributors may be used to endorse or promote products derived 0132 * from this software without specific prior written permission. 0133 * 0134 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 0135 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 0136 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 0137 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 0138 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 0139 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 0140 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 0141 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 0142 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 0143 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 0144 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 0145 * 0146 * Alternatively, you may choose to be licensed under the terms of the 0147 * GNU General Public License ("GPL") version 2 as published by the Free 0148 * Software Foundation. 0149 * 0150 *****************************************************************************/ 0151 0152 #ifndef __ACDEBUG_H__ 0153 #define __ACDEBUG_H__ 0154 0155 /* The debugger is used in conjunction with the disassembler most of time */ 0156 0157 #ifdef ACPI_DISASSEMBLER 0158 #include "acdisasm.h" 0159 #endif 0160 0161 0162 #define ACPI_DEBUG_BUFFER_SIZE 0x4000 /* 16K buffer for return objects */ 0163 #define ACPI_DEBUG_LENGTH_FORMAT " (%.4X bits, %.3X bytes)" 0164 0165 typedef struct acpi_db_command_info 0166 { 0167 const char *Name; /* Command Name */ 0168 UINT8 MinArgs; /* Minimum arguments required */ 0169 0170 } ACPI_DB_COMMAND_INFO; 0171 0172 typedef struct acpi_db_command_help 0173 { 0174 UINT8 LineCount; /* Number of help lines */ 0175 char *Invocation; /* Command Invocation */ 0176 char *Description; /* Command Description */ 0177 0178 } ACPI_DB_COMMAND_HELP; 0179 0180 typedef struct acpi_db_argument_info 0181 { 0182 const char *Name; /* Argument Name */ 0183 0184 } ACPI_DB_ARGUMENT_INFO; 0185 0186 typedef struct acpi_db_execute_walk 0187 { 0188 UINT32 Count; 0189 UINT32 MaxCount; 0190 char NameSeg[ACPI_NAMESEG_SIZE + 1]; 0191 0192 } ACPI_DB_EXECUTE_WALK; 0193 0194 0195 #define PARAM_LIST(pl) pl 0196 0197 #define EX_NO_SINGLE_STEP 1 0198 #define EX_SINGLE_STEP 2 0199 #define EX_ALL 4 0200 0201 0202 /* 0203 * dbxface - external debugger interfaces 0204 */ 0205 ACPI_DBR_DEPENDENT_RETURN_OK ( 0206 ACPI_STATUS 0207 AcpiDbSingleStep ( 0208 ACPI_WALK_STATE *WalkState, 0209 ACPI_PARSE_OBJECT *Op, 0210 UINT32 OpType)) 0211 0212 ACPI_DBR_DEPENDENT_RETURN_VOID ( 0213 void 0214 AcpiDbSignalBreakPoint ( 0215 ACPI_WALK_STATE *WalkState)) 0216 0217 0218 /* 0219 * dbcmds - debug commands and output routines 0220 */ 0221 ACPI_NAMESPACE_NODE * 0222 AcpiDbConvertToNode ( 0223 char *InString); 0224 0225 void 0226 AcpiDbDisplayTableInfo ( 0227 char *TableArg); 0228 0229 void 0230 AcpiDbDisplayTemplate ( 0231 char *BufferArg); 0232 0233 void 0234 AcpiDbUnloadAcpiTable ( 0235 char *Name); 0236 0237 void 0238 AcpiDbSendNotify ( 0239 char *Name, 0240 UINT32 Value); 0241 0242 void 0243 AcpiDbDisplayInterfaces ( 0244 char *ActionArg, 0245 char *InterfaceNameArg); 0246 0247 ACPI_STATUS 0248 AcpiDbSleep ( 0249 char *ObjectArg); 0250 0251 void 0252 AcpiDbTrace ( 0253 char *EnableArg, 0254 char *MethodArg, 0255 char *OnceArg); 0256 0257 void 0258 AcpiDbDisplayLocks ( 0259 void); 0260 0261 void 0262 AcpiDbDisplayResources ( 0263 char *ObjectArg); 0264 0265 ACPI_HW_DEPENDENT_RETURN_VOID ( 0266 void 0267 AcpiDbDisplayGpes ( 0268 void)) 0269 0270 void 0271 AcpiDbDisplayHandlers ( 0272 void); 0273 0274 ACPI_HW_DEPENDENT_RETURN_VOID ( 0275 void 0276 AcpiDbGenerateGpe ( 0277 char *GpeArg, 0278 char *BlockArg)) 0279 0280 ACPI_HW_DEPENDENT_RETURN_VOID ( 0281 void 0282 AcpiDbGenerateSci ( 0283 void)) 0284 0285 void 0286 AcpiDbExecuteTest ( 0287 char *TypeArg); 0288 0289 0290 /* 0291 * dbconvert - miscellaneous conversion routines 0292 */ 0293 ACPI_STATUS 0294 AcpiDbHexCharToValue ( 0295 int HexChar, 0296 UINT8 *ReturnValue); 0297 0298 ACPI_STATUS 0299 AcpiDbConvertToPackage ( 0300 char *String, 0301 ACPI_OBJECT *Object); 0302 0303 ACPI_STATUS 0304 AcpiDbConvertToObject ( 0305 ACPI_OBJECT_TYPE Type, 0306 char *String, 0307 ACPI_OBJECT *Object); 0308 0309 UINT8 * 0310 AcpiDbEncodePldBuffer ( 0311 ACPI_PLD_INFO *PldInfo); 0312 0313 void 0314 AcpiDbDumpPldBuffer ( 0315 ACPI_OBJECT *ObjDesc); 0316 0317 0318 /* 0319 * dbmethod - control method commands 0320 */ 0321 void 0322 AcpiDbSetMethodBreakpoint ( 0323 char *Location, 0324 ACPI_WALK_STATE *WalkState, 0325 ACPI_PARSE_OBJECT *Op); 0326 0327 void 0328 AcpiDbSetMethodCallBreakpoint ( 0329 ACPI_PARSE_OBJECT *Op); 0330 0331 void 0332 AcpiDbSetMethodData ( 0333 char *TypeArg, 0334 char *IndexArg, 0335 char *ValueArg); 0336 0337 ACPI_STATUS 0338 AcpiDbDisassembleMethod ( 0339 char *Name); 0340 0341 void 0342 AcpiDbDisassembleAml ( 0343 char *Statements, 0344 ACPI_PARSE_OBJECT *Op); 0345 0346 void 0347 AcpiDbEvaluatePredefinedNames ( 0348 void); 0349 0350 void 0351 AcpiDbEvaluateAll ( 0352 char *NameSeg); 0353 0354 0355 /* 0356 * dbnames - namespace commands 0357 */ 0358 void 0359 AcpiDbSetScope ( 0360 char *Name); 0361 0362 void 0363 AcpiDbDumpNamespace ( 0364 char *StartArg, 0365 char *DepthArg); 0366 0367 void 0368 AcpiDbDumpNamespacePaths ( 0369 void); 0370 0371 void 0372 AcpiDbDumpNamespaceByOwner ( 0373 char *OwnerArg, 0374 char *DepthArg); 0375 0376 ACPI_STATUS 0377 AcpiDbFindNameInNamespace ( 0378 char *NameArg); 0379 0380 void 0381 AcpiDbCheckPredefinedNames ( 0382 void); 0383 0384 ACPI_STATUS 0385 AcpiDbDisplayObjects ( 0386 char *ObjTypeArg, 0387 char *DisplayCountArg); 0388 0389 void 0390 AcpiDbCheckIntegrity ( 0391 void); 0392 0393 void 0394 AcpiDbFindReferences ( 0395 char *ObjectArg); 0396 0397 void 0398 AcpiDbGetBusInfo ( 0399 void); 0400 0401 ACPI_STATUS 0402 AcpiDbDisplayFields ( 0403 UINT32 AddressSpaceId); 0404 0405 0406 /* 0407 * dbdisply - debug display commands 0408 */ 0409 void 0410 AcpiDbDisplayMethodInfo ( 0411 ACPI_PARSE_OBJECT *Op); 0412 0413 void 0414 AcpiDbDecodeAndDisplayObject ( 0415 char *Target, 0416 char *OutputType); 0417 0418 ACPI_DBR_DEPENDENT_RETURN_VOID ( 0419 void 0420 AcpiDbDisplayResultObject ( 0421 ACPI_OPERAND_OBJECT *ObjDesc, 0422 ACPI_WALK_STATE *WalkState)) 0423 0424 ACPI_STATUS 0425 AcpiDbDisplayAllMethods ( 0426 char *DisplayCountArg); 0427 0428 void 0429 AcpiDbDisplayArguments ( 0430 void); 0431 0432 void 0433 AcpiDbDisplayLocals ( 0434 void); 0435 0436 void 0437 AcpiDbDisplayResults ( 0438 void); 0439 0440 void 0441 AcpiDbDisplayCallingTree ( 0442 void); 0443 0444 void 0445 AcpiDbDisplayObjectType ( 0446 char *ObjectArg); 0447 0448 ACPI_DBR_DEPENDENT_RETURN_VOID ( 0449 void 0450 AcpiDbDisplayArgumentObject ( 0451 ACPI_OPERAND_OBJECT *ObjDesc, 0452 ACPI_WALK_STATE *WalkState)) 0453 0454 0455 /* 0456 * dbexec - debugger control method execution 0457 */ 0458 void 0459 AcpiDbExecute ( 0460 char *Name, 0461 char **Args, 0462 ACPI_OBJECT_TYPE *Types, 0463 UINT32 Flags); 0464 0465 void 0466 AcpiDbCreateExecutionThread ( 0467 char *MethodNameArg, 0468 char **Arguments, 0469 ACPI_OBJECT_TYPE *Types); 0470 0471 void 0472 AcpiDbCreateExecutionThreads ( 0473 char *NumThreadsArg, 0474 char *NumLoopsArg, 0475 char *MethodNameArg); 0476 0477 void 0478 AcpiDbDeleteObjects ( 0479 UINT32 Count, 0480 ACPI_OBJECT *Objects); 0481 0482 #ifdef ACPI_DBG_TRACK_ALLOCATIONS 0483 UINT32 0484 AcpiDbGetCacheInfo ( 0485 ACPI_MEMORY_LIST *Cache); 0486 #endif 0487 0488 0489 /* 0490 * dbfileio - Debugger file I/O commands 0491 */ 0492 ACPI_OBJECT_TYPE 0493 AcpiDbMatchArgument ( 0494 char *UserArgument, 0495 ACPI_DB_ARGUMENT_INFO *Arguments); 0496 0497 void 0498 AcpiDbCloseDebugFile ( 0499 void); 0500 0501 void 0502 AcpiDbOpenDebugFile ( 0503 char *Name); 0504 0505 ACPI_STATUS 0506 AcpiDbLoadAcpiTable ( 0507 char *Filename); 0508 0509 ACPI_STATUS 0510 AcpiDbLoadTables ( 0511 ACPI_NEW_TABLE_DESC *ListHead); 0512 0513 0514 /* 0515 * dbhistry - debugger HISTORY command 0516 */ 0517 void 0518 AcpiDbAddToHistory ( 0519 char *CommandLine); 0520 0521 void 0522 AcpiDbDisplayHistory ( 0523 void); 0524 0525 char * 0526 AcpiDbGetFromHistory ( 0527 char *CommandNumArg); 0528 0529 char * 0530 AcpiDbGetHistoryByIndex ( 0531 UINT32 CommanddNum); 0532 0533 0534 /* 0535 * dbinput - user front-end to the AML debugger 0536 */ 0537 ACPI_STATUS 0538 AcpiDbCommandDispatch ( 0539 char *InputBuffer, 0540 ACPI_WALK_STATE *WalkState, 0541 ACPI_PARSE_OBJECT *Op); 0542 0543 void ACPI_SYSTEM_XFACE 0544 AcpiDbExecuteThread ( 0545 void *Context); 0546 0547 ACPI_STATUS 0548 AcpiDbUserCommands ( 0549 void); 0550 0551 char * 0552 AcpiDbGetNextToken ( 0553 char *String, 0554 char **Next, 0555 ACPI_OBJECT_TYPE *ReturnType); 0556 0557 0558 /* 0559 * dbobject 0560 */ 0561 void 0562 AcpiDbDecodeInternalObject ( 0563 ACPI_OPERAND_OBJECT *ObjDesc); 0564 0565 void 0566 AcpiDbDisplayInternalObject ( 0567 ACPI_OPERAND_OBJECT *ObjDesc, 0568 ACPI_WALK_STATE *WalkState); 0569 0570 void 0571 AcpiDbDecodeArguments ( 0572 ACPI_WALK_STATE *WalkState); 0573 0574 void 0575 AcpiDbDecodeLocals ( 0576 ACPI_WALK_STATE *WalkState); 0577 0578 void 0579 AcpiDbDumpMethodInfo ( 0580 ACPI_STATUS Status, 0581 ACPI_WALK_STATE *WalkState); 0582 0583 0584 /* 0585 * dbstats - Generation and display of ACPI table statistics 0586 */ 0587 void 0588 AcpiDbGenerateStatistics ( 0589 ACPI_PARSE_OBJECT *Root, 0590 BOOLEAN IsMethod); 0591 0592 ACPI_STATUS 0593 AcpiDbDisplayStatistics ( 0594 char *TypeArg); 0595 0596 0597 /* 0598 * dbutils - AML debugger utilities 0599 */ 0600 void 0601 AcpiDbSetOutputDestination ( 0602 UINT32 Where); 0603 0604 void 0605 AcpiDbDumpExternalObject ( 0606 ACPI_OBJECT *ObjDesc, 0607 UINT32 Level); 0608 0609 void 0610 AcpiDbPrepNamestring ( 0611 char *Name); 0612 0613 ACPI_NAMESPACE_NODE * 0614 AcpiDbLocalNsLookup ( 0615 char *Name); 0616 0617 void 0618 AcpiDbUint32ToHexString ( 0619 UINT32 Value, 0620 char *Buffer); 0621 0622 void 0623 AcpiDbGenerateInterrupt ( 0624 char *GsivArg); 0625 0626 #endif /* __ACDEBUG_H__ */
| [ Source navigation ] | [ Diff markup ] | [ Identifier search ] | [ general search ] |
|
This page was automatically generated by the 2.3.7 LXR engine. The LXR team |
|