1/******************************************************************************* 2 * 3 * Module Name: dmutils - AML disassembler utilities 4 * 5 ******************************************************************************/ 6 7/****************************************************************************** 8 * 9 * 1. Copyright Notice 10 * 11 * Some or all of this work - Copyright (c) 1999 - 2016, 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 "amlcode.h" 119#include "acdisasm.h" 120 121#ifdef ACPI_ASL_COMPILER 122#include <acnamesp.h> 123#endif 124 125 126#define _COMPONENT ACPI_CA_DEBUGGER 127 ACPI_MODULE_NAME ("dmutils") 128 129 130/* Data used in keeping track of fields */ 131#if 0 132const char *AcpiGbl_FENames[] = 133{ 134 "skip", 135 "?access?" 136}; /* FE = Field Element */ 137#endif 138 139/* Operators for Match() */ 140 141const char *AcpiGbl_MatchOps[] = 142{ 143 "MTR", 144 "MEQ", 145 "MLE", 146 "MLT", 147 "MGE", 148 "MGT" 149}; 150 151/* Access type decoding */ 152 153const char *AcpiGbl_AccessTypes[] = 154{ 155 "AnyAcc", 156 "ByteAcc", 157 "WordAcc", 158 "DWordAcc", 159 "QWordAcc", 160 "BufferAcc", 161 "InvalidAccType", 162 "InvalidAccType" 163}; 164 165/* Lock rule decoding */ 166 167const char *AcpiGbl_LockRule[] = 168{ 169 "NoLock", 170 "Lock" 171}; 172 173/* Update rule decoding */ 174 175const char *AcpiGbl_UpdateRules[] = 176{ 177 "Preserve", 178 "WriteAsOnes", 179 "WriteAsZeros", 180 "InvalidUpdateRule" 181}; 182 183/* Strings used to decode resource descriptors */ 184 185const char *AcpiGbl_WordDecode[] = 186{ 187 "Memory", 188 "IO", 189 "BusNumber", 190 "UnknownResourceType" 191}; 192 193const char *AcpiGbl_IrqDecode[] = 194{ 195 "IRQNoFlags", 196 "IRQ" 197}; 198 199 200/******************************************************************************* 201 * 202 * FUNCTION: AcpiDmDecodeAttribute 203 * 204 * PARAMETERS: Attribute - Attribute field of AccessAs keyword 205 * 206 * RETURN: None 207 * 208 * DESCRIPTION: Decode the AccessAs attribute byte. (Mostly SMBus and 209 * GenericSerialBus stuff.) 210 * 211 ******************************************************************************/ 212 213void 214AcpiDmDecodeAttribute ( 215 UINT8 Attribute) 216{ 217 218 switch (Attribute) 219 { 220 case AML_FIELD_ATTRIB_QUICK: 221 222 AcpiOsPrintf ("AttribQuick"); 223 break; 224 225 case AML_FIELD_ATTRIB_SEND_RCV: 226 227 AcpiOsPrintf ("AttribSendReceive"); 228 break; 229 230 case AML_FIELD_ATTRIB_BYTE: 231 232 AcpiOsPrintf ("AttribByte"); 233 break; 234 235 case AML_FIELD_ATTRIB_WORD: 236 237 AcpiOsPrintf ("AttribWord"); 238 break; 239 240 case AML_FIELD_ATTRIB_BLOCK: 241 242 AcpiOsPrintf ("AttribBlock"); 243 break; 244 245 case AML_FIELD_ATTRIB_MULTIBYTE: 246 247 AcpiOsPrintf ("AttribBytes"); 248 break; 249 250 case AML_FIELD_ATTRIB_WORD_CALL: 251 252 AcpiOsPrintf ("AttribProcessCall"); 253 break; 254 255 case AML_FIELD_ATTRIB_BLOCK_CALL: 256 257 AcpiOsPrintf ("AttribBlockProcessCall"); 258 break; 259 260 case AML_FIELD_ATTRIB_RAW_BYTES: 261 262 AcpiOsPrintf ("AttribRawBytes"); 263 break; 264 265 case AML_FIELD_ATTRIB_RAW_PROCESS: 266 267 AcpiOsPrintf ("AttribRawProcessBytes"); 268 break; 269 270 default: 271 272 /* A ByteConst is allowed by the grammar */ 273 274 AcpiOsPrintf ("0x%2.2X", Attribute); 275 break; 276 } 277} 278 279 280/******************************************************************************* 281 * 282 * FUNCTION: AcpiDmIndent 283 * 284 * PARAMETERS: Level - Current source code indentation level 285 * 286 * RETURN: None 287 * 288 * DESCRIPTION: Indent 4 spaces per indentation level. 289 * 290 ******************************************************************************/ 291 292void 293AcpiDmIndent ( 294 UINT32 Level) 295{ 296 297 if (!Level) 298 { 299 return; 300 } 301 302 AcpiOsPrintf ("%*.s", (Level * 4), " "); 303} 304 305 306/******************************************************************************* 307 * 308 * FUNCTION: AcpiDmCommaIfListMember 309 * 310 * PARAMETERS: Op - Current operator/operand 311 * 312 * RETURN: TRUE if a comma was inserted 313 * 314 * DESCRIPTION: Insert a comma if this Op is a member of an argument list. 315 * 316 ******************************************************************************/ 317 318BOOLEAN 319AcpiDmCommaIfListMember ( 320 ACPI_PARSE_OBJECT *Op) 321{ 322 323 if (!Op->Common.Next) 324 { 325 return (FALSE); 326 } 327 328 if (AcpiDmListType (Op->Common.Parent) & BLOCK_COMMA_LIST) 329 { 330 /* Exit if Target has been marked IGNORE */ 331 332 if (Op->Common.Next->Common.DisasmFlags & ACPI_PARSEOP_IGNORE) 333 { 334 return (FALSE); 335 } 336 337 /* Check for a NULL target operand */ 338 339 if ((Op->Common.Next->Common.AmlOpcode == AML_INT_NAMEPATH_OP) && 340 (!Op->Common.Next->Common.Value.String)) 341 { 342 /* 343 * To handle the Divide() case where there are two optional 344 * targets, look ahead one more op. If null, this null target 345 * is the one and only target -- no comma needed. Otherwise, 346 * we need a comma to prepare for the next target. 347 */ 348 if (!Op->Common.Next->Common.Next) 349 { 350 return (FALSE); 351 } 352 } 353 354 if ((Op->Common.DisasmFlags & ACPI_PARSEOP_PARAMETER_LIST) && 355 (!(Op->Common.Next->Common.DisasmFlags & ACPI_PARSEOP_PARAMETER_LIST))) 356 { 357 return (FALSE); 358 } 359 360 /* Emit comma only if this is not a C-style operator */ 361 362 if (!Op->Common.OperatorSymbol) 363 { 364 AcpiOsPrintf (", "); 365 } 366 367 return (TRUE); 368 } 369 370 else if ((Op->Common.DisasmFlags & ACPI_PARSEOP_PARAMETER_LIST) && 371 (Op->Common.Next->Common.DisasmFlags & ACPI_PARSEOP_PARAMETER_LIST)) 372 { 373 AcpiOsPrintf (", "); 374 return (TRUE); 375 } 376 377 return (FALSE); 378} 379 380 381/******************************************************************************* 382 * 383 * FUNCTION: AcpiDmCommaIfFieldMember 384 * 385 * PARAMETERS: Op - Current operator/operand 386 * 387 * RETURN: None 388 * 389 * DESCRIPTION: Insert a comma if this Op is a member of a Field argument list. 390 * 391 ******************************************************************************/ 392 393void 394AcpiDmCommaIfFieldMember ( 395 ACPI_PARSE_OBJECT *Op) 396{ 397 398 if (Op->Common.Next) 399 { 400 AcpiOsPrintf (", "); 401 } 402} 403