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