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