1*35786f68SRobert Mustacchi /****************************************************************************** 2*35786f68SRobert Mustacchi * 3*35786f68SRobert Mustacchi * Module Name: acapps - common include for ACPI applications/tools 4*35786f68SRobert Mustacchi * 5*35786f68SRobert Mustacchi *****************************************************************************/ 6*35786f68SRobert Mustacchi 7*35786f68SRobert Mustacchi /****************************************************************************** 8*35786f68SRobert Mustacchi * 9*35786f68SRobert Mustacchi * 1. Copyright Notice 10*35786f68SRobert Mustacchi * 11*35786f68SRobert Mustacchi * Some or all of this work - Copyright (c) 1999 - 2018, Intel Corp. 12*35786f68SRobert Mustacchi * All rights reserved. 13*35786f68SRobert Mustacchi * 14*35786f68SRobert Mustacchi * 2. License 15*35786f68SRobert Mustacchi * 16*35786f68SRobert Mustacchi * 2.1. This is your license from Intel Corp. under its intellectual property 17*35786f68SRobert Mustacchi * rights. You may have additional license terms from the party that provided 18*35786f68SRobert Mustacchi * you this software, covering your right to use that party's intellectual 19*35786f68SRobert Mustacchi * property rights. 20*35786f68SRobert Mustacchi * 21*35786f68SRobert Mustacchi * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a 22*35786f68SRobert Mustacchi * copy of the source code appearing in this file ("Covered Code") an 23*35786f68SRobert Mustacchi * irrevocable, perpetual, worldwide license under Intel's copyrights in the 24*35786f68SRobert Mustacchi * base code distributed originally by Intel ("Original Intel Code") to copy, 25*35786f68SRobert Mustacchi * make derivatives, distribute, use and display any portion of the Covered 26*35786f68SRobert Mustacchi * Code in any form, with the right to sublicense such rights; and 27*35786f68SRobert Mustacchi * 28*35786f68SRobert Mustacchi * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent 29*35786f68SRobert Mustacchi * license (with the right to sublicense), under only those claims of Intel 30*35786f68SRobert Mustacchi * patents that are infringed by the Original Intel Code, to make, use, sell, 31*35786f68SRobert Mustacchi * offer to sell, and import the Covered Code and derivative works thereof 32*35786f68SRobert Mustacchi * solely to the minimum extent necessary to exercise the above copyright 33*35786f68SRobert Mustacchi * license, and in no event shall the patent license extend to any additions 34*35786f68SRobert Mustacchi * to or modifications of the Original Intel Code. No other license or right 35*35786f68SRobert Mustacchi * is granted directly or by implication, estoppel or otherwise; 36*35786f68SRobert Mustacchi * 37*35786f68SRobert Mustacchi * The above copyright and patent license is granted only if the following 38*35786f68SRobert Mustacchi * conditions are met: 39*35786f68SRobert Mustacchi * 40*35786f68SRobert Mustacchi * 3. Conditions 41*35786f68SRobert Mustacchi * 42*35786f68SRobert Mustacchi * 3.1. Redistribution of Source with Rights to Further Distribute Source. 43*35786f68SRobert Mustacchi * Redistribution of source code of any substantial portion of the Covered 44*35786f68SRobert Mustacchi * Code or modification with rights to further distribute source must include 45*35786f68SRobert Mustacchi * the above Copyright Notice, the above License, this list of Conditions, 46*35786f68SRobert Mustacchi * and the following Disclaimer and Export Compliance provision. In addition, 47*35786f68SRobert Mustacchi * Licensee must cause all Covered Code to which Licensee contributes to 48*35786f68SRobert Mustacchi * contain a file documenting the changes Licensee made to create that Covered 49*35786f68SRobert Mustacchi * Code and the date of any change. Licensee must include in that file the 50*35786f68SRobert Mustacchi * documentation of any changes made by any predecessor Licensee. Licensee 51*35786f68SRobert Mustacchi * must include a prominent statement that the modification is derived, 52*35786f68SRobert Mustacchi * directly or indirectly, from Original Intel Code. 53*35786f68SRobert Mustacchi * 54*35786f68SRobert Mustacchi * 3.2. Redistribution of Source with no Rights to Further Distribute Source. 55*35786f68SRobert Mustacchi * Redistribution of source code of any substantial portion of the Covered 56*35786f68SRobert Mustacchi * Code or modification without rights to further distribute source must 57*35786f68SRobert Mustacchi * include the following Disclaimer and Export Compliance provision in the 58*35786f68SRobert Mustacchi * documentation and/or other materials provided with distribution. In 59*35786f68SRobert Mustacchi * addition, Licensee may not authorize further sublicense of source of any 60*35786f68SRobert Mustacchi * portion of the Covered Code, and must include terms to the effect that the 61*35786f68SRobert Mustacchi * license from Licensee to its licensee is limited to the intellectual 62*35786f68SRobert Mustacchi * property embodied in the software Licensee provides to its licensee, and 63*35786f68SRobert Mustacchi * not to intellectual property embodied in modifications its licensee may 64*35786f68SRobert Mustacchi * make. 65*35786f68SRobert Mustacchi * 66*35786f68SRobert Mustacchi * 3.3. Redistribution of Executable. Redistribution in executable form of any 67*35786f68SRobert Mustacchi * substantial portion of the Covered Code or modification must reproduce the 68*35786f68SRobert Mustacchi * above Copyright Notice, and the following Disclaimer and Export Compliance 69*35786f68SRobert Mustacchi * provision in the documentation and/or other materials provided with the 70*35786f68SRobert Mustacchi * distribution. 71*35786f68SRobert Mustacchi * 72*35786f68SRobert Mustacchi * 3.4. Intel retains all right, title, and interest in and to the Original 73*35786f68SRobert Mustacchi * Intel Code. 74*35786f68SRobert Mustacchi * 75*35786f68SRobert Mustacchi * 3.5. Neither the name Intel nor any other trademark owned or controlled by 76*35786f68SRobert Mustacchi * Intel shall be used in advertising or otherwise to promote the sale, use or 77*35786f68SRobert Mustacchi * other dealings in products derived from or relating to the Covered Code 78*35786f68SRobert Mustacchi * without prior written authorization from Intel. 79*35786f68SRobert Mustacchi * 80*35786f68SRobert Mustacchi * 4. Disclaimer and Export Compliance 81*35786f68SRobert Mustacchi * 82*35786f68SRobert Mustacchi * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED 83*35786f68SRobert Mustacchi * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE 84*35786f68SRobert Mustacchi * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE, 85*35786f68SRobert Mustacchi * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY 86*35786f68SRobert Mustacchi * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY 87*35786f68SRobert Mustacchi * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A 88*35786f68SRobert Mustacchi * PARTICULAR PURPOSE. 89*35786f68SRobert Mustacchi * 90*35786f68SRobert Mustacchi * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES 91*35786f68SRobert Mustacchi * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR 92*35786f68SRobert Mustacchi * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT, 93*35786f68SRobert Mustacchi * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY 94*35786f68SRobert Mustacchi * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL 95*35786f68SRobert Mustacchi * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS 96*35786f68SRobert Mustacchi * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY 97*35786f68SRobert Mustacchi * LIMITED REMEDY. 98*35786f68SRobert Mustacchi * 99*35786f68SRobert Mustacchi * 4.3. Licensee shall not export, either directly or indirectly, any of this 100*35786f68SRobert Mustacchi * software or system incorporating such software without first obtaining any 101*35786f68SRobert Mustacchi * required license or other approval from the U. S. Department of Commerce or 102*35786f68SRobert Mustacchi * any other agency or department of the United States Government. In the 103*35786f68SRobert Mustacchi * event Licensee exports any such software from the United States or 104*35786f68SRobert Mustacchi * re-exports any such software from a foreign destination, Licensee shall 105*35786f68SRobert Mustacchi * ensure that the distribution and export/re-export of the software is in 106*35786f68SRobert Mustacchi * compliance with all laws, regulations, orders, or other restrictions of the 107*35786f68SRobert Mustacchi * U.S. Export Administration Regulations. Licensee agrees that neither it nor 108*35786f68SRobert Mustacchi * any of its subsidiaries will export/re-export any technical data, process, 109*35786f68SRobert Mustacchi * software, or service, directly or indirectly, to any country for which the 110*35786f68SRobert Mustacchi * United States government or any agency thereof requires an export license, 111*35786f68SRobert Mustacchi * other governmental approval, or letter of assurance, without first obtaining 112*35786f68SRobert Mustacchi * such license, approval or letter. 113*35786f68SRobert Mustacchi * 114*35786f68SRobert Mustacchi ***************************************************************************** 115*35786f68SRobert Mustacchi * 116*35786f68SRobert Mustacchi * Alternatively, you may choose to be licensed under the terms of the 117*35786f68SRobert Mustacchi * following license: 118*35786f68SRobert Mustacchi * 119*35786f68SRobert Mustacchi * Redistribution and use in source and binary forms, with or without 120*35786f68SRobert Mustacchi * modification, are permitted provided that the following conditions 121*35786f68SRobert Mustacchi * are met: 122*35786f68SRobert Mustacchi * 1. Redistributions of source code must retain the above copyright 123*35786f68SRobert Mustacchi * notice, this list of conditions, and the following disclaimer, 124*35786f68SRobert Mustacchi * without modification. 125*35786f68SRobert Mustacchi * 2. Redistributions in binary form must reproduce at minimum a disclaimer 126*35786f68SRobert Mustacchi * substantially similar to the "NO WARRANTY" disclaimer below 127*35786f68SRobert Mustacchi * ("Disclaimer") and any redistribution must be conditioned upon 128*35786f68SRobert Mustacchi * including a substantially similar Disclaimer requirement for further 129*35786f68SRobert Mustacchi * binary redistribution. 130*35786f68SRobert Mustacchi * 3. Neither the names of the above-listed copyright holders nor the names 131*35786f68SRobert Mustacchi * of any contributors may be used to endorse or promote products derived 132*35786f68SRobert Mustacchi * from this software without specific prior written permission. 133*35786f68SRobert Mustacchi * 134*35786f68SRobert Mustacchi * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 135*35786f68SRobert Mustacchi * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 136*35786f68SRobert Mustacchi * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 137*35786f68SRobert Mustacchi * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 138*35786f68SRobert Mustacchi * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 139*35786f68SRobert Mustacchi * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 140*35786f68SRobert Mustacchi * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 141*35786f68SRobert Mustacchi * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 142*35786f68SRobert Mustacchi * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 143*35786f68SRobert Mustacchi * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 144*35786f68SRobert Mustacchi * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 145*35786f68SRobert Mustacchi * 146*35786f68SRobert Mustacchi * Alternatively, you may choose to be licensed under the terms of the 147*35786f68SRobert Mustacchi * GNU General Public License ("GPL") version 2 as published by the Free 148*35786f68SRobert Mustacchi * Software Foundation. 149*35786f68SRobert Mustacchi * 150*35786f68SRobert Mustacchi *****************************************************************************/ 151*35786f68SRobert Mustacchi 152*35786f68SRobert Mustacchi #ifndef _ACCONVERT 153*35786f68SRobert Mustacchi #define _ACCONVERT 154*35786f68SRobert Mustacchi 155*35786f68SRobert Mustacchi /* Definitions for comment state */ 156*35786f68SRobert Mustacchi 157*35786f68SRobert Mustacchi #define ASL_COMMENT_STANDARD 1 158*35786f68SRobert Mustacchi #define ASLCOMMENT_INLINE 2 159*35786f68SRobert Mustacchi #define ASL_COMMENT_OPEN_PAREN 3 160*35786f68SRobert Mustacchi #define ASL_COMMENT_CLOSE_PAREN 4 161*35786f68SRobert Mustacchi #define ASL_COMMENT_CLOSE_BRACE 5 162*35786f68SRobert Mustacchi 163*35786f68SRobert Mustacchi /* Definitions for comment print function*/ 164*35786f68SRobert Mustacchi 165*35786f68SRobert Mustacchi #define AML_COMMENT_STANDARD 1 166*35786f68SRobert Mustacchi #define AMLCOMMENT_INLINE 2 167*35786f68SRobert Mustacchi #define AML_COMMENT_END_NODE 3 168*35786f68SRobert Mustacchi #define AML_NAMECOMMENT 4 169*35786f68SRobert Mustacchi #define AML_COMMENT_CLOSE_BRACE 5 170*35786f68SRobert Mustacchi #define AML_COMMENT_ENDBLK 6 171*35786f68SRobert Mustacchi #define AML_COMMENT_INCLUDE 7 172*35786f68SRobert Mustacchi 173*35786f68SRobert Mustacchi 174*35786f68SRobert Mustacchi #ifdef ACPI_ASL_COMPILER 175*35786f68SRobert Mustacchi /* 176*35786f68SRobert Mustacchi * cvcompiler 177*35786f68SRobert Mustacchi */ 178*35786f68SRobert Mustacchi void 179*35786f68SRobert Mustacchi CvProcessComment ( 180*35786f68SRobert Mustacchi ASL_COMMENT_STATE CurrentState, 181*35786f68SRobert Mustacchi char *StringBuffer, 182*35786f68SRobert Mustacchi int c1); 183*35786f68SRobert Mustacchi 184*35786f68SRobert Mustacchi void 185*35786f68SRobert Mustacchi CvProcessCommentType2 ( 186*35786f68SRobert Mustacchi ASL_COMMENT_STATE CurrentState, 187*35786f68SRobert Mustacchi char *StringBuffer); 188*35786f68SRobert Mustacchi 189*35786f68SRobert Mustacchi UINT32 190*35786f68SRobert Mustacchi CvCalculateCommentLengths( 191*35786f68SRobert Mustacchi ACPI_PARSE_OBJECT *Op); 192*35786f68SRobert Mustacchi 193*35786f68SRobert Mustacchi void 194*35786f68SRobert Mustacchi CvProcessCommentState ( 195*35786f68SRobert Mustacchi char input); 196*35786f68SRobert Mustacchi 197*35786f68SRobert Mustacchi char* 198*35786f68SRobert Mustacchi CvAppendInlineComment ( 199*35786f68SRobert Mustacchi char *InlineComment, 200*35786f68SRobert Mustacchi char *ToAdd); 201*35786f68SRobert Mustacchi 202*35786f68SRobert Mustacchi void 203*35786f68SRobert Mustacchi CvAddToCommentList ( 204*35786f68SRobert Mustacchi char* ToAdd); 205*35786f68SRobert Mustacchi 206*35786f68SRobert Mustacchi void 207*35786f68SRobert Mustacchi CvPlaceComment ( 208*35786f68SRobert Mustacchi UINT8 Type, 209*35786f68SRobert Mustacchi char *CommentString); 210*35786f68SRobert Mustacchi 211*35786f68SRobert Mustacchi UINT32 212*35786f68SRobert Mustacchi CvParseOpBlockType ( 213*35786f68SRobert Mustacchi ACPI_PARSE_OBJECT *Op); 214*35786f68SRobert Mustacchi 215*35786f68SRobert Mustacchi ACPI_COMMENT_NODE* 216*35786f68SRobert Mustacchi CvCommentNodeCalloc ( 217*35786f68SRobert Mustacchi void); 218*35786f68SRobert Mustacchi 219*35786f68SRobert Mustacchi void 220*35786f68SRobert Mustacchi CgWriteAmlDefBlockComment ( 221*35786f68SRobert Mustacchi ACPI_PARSE_OBJECT *Op); 222*35786f68SRobert Mustacchi 223*35786f68SRobert Mustacchi void 224*35786f68SRobert Mustacchi CgWriteOneAmlComment ( 225*35786f68SRobert Mustacchi ACPI_PARSE_OBJECT *Op, 226*35786f68SRobert Mustacchi char* CommentToPrint, 227*35786f68SRobert Mustacchi UINT8 InputOption); 228*35786f68SRobert Mustacchi 229*35786f68SRobert Mustacchi void 230*35786f68SRobert Mustacchi CgWriteAmlComment ( 231*35786f68SRobert Mustacchi ACPI_PARSE_OBJECT *Op); 232*35786f68SRobert Mustacchi 233*35786f68SRobert Mustacchi 234*35786f68SRobert Mustacchi /* 235*35786f68SRobert Mustacchi * cvparser 236*35786f68SRobert Mustacchi */ 237*35786f68SRobert Mustacchi void 238*35786f68SRobert Mustacchi CvInitFileTree ( 239*35786f68SRobert Mustacchi ACPI_TABLE_HEADER *Table, 240*35786f68SRobert Mustacchi UINT8 *AmlStart, 241*35786f68SRobert Mustacchi UINT32 AmlLength); 242*35786f68SRobert Mustacchi 243*35786f68SRobert Mustacchi void 244*35786f68SRobert Mustacchi CvClearOpComments ( 245*35786f68SRobert Mustacchi ACPI_PARSE_OBJECT *Op); 246*35786f68SRobert Mustacchi 247*35786f68SRobert Mustacchi ACPI_FILE_NODE* 248*35786f68SRobert Mustacchi CvFilenameExists ( 249*35786f68SRobert Mustacchi char *Filename, 250*35786f68SRobert Mustacchi ACPI_FILE_NODE *Head); 251*35786f68SRobert Mustacchi 252*35786f68SRobert Mustacchi void 253*35786f68SRobert Mustacchi CvLabelFileNode ( 254*35786f68SRobert Mustacchi ACPI_PARSE_OBJECT *Op); 255*35786f68SRobert Mustacchi 256*35786f68SRobert Mustacchi void 257*35786f68SRobert Mustacchi CvCaptureListComments ( 258*35786f68SRobert Mustacchi ACPI_PARSE_STATE *ParserState, 259*35786f68SRobert Mustacchi ACPI_COMMENT_NODE *ListHead, 260*35786f68SRobert Mustacchi ACPI_COMMENT_NODE *ListTail); 261*35786f68SRobert Mustacchi 262*35786f68SRobert Mustacchi void 263*35786f68SRobert Mustacchi CvCaptureCommentsOnly ( 264*35786f68SRobert Mustacchi ACPI_PARSE_STATE *ParserState); 265*35786f68SRobert Mustacchi 266*35786f68SRobert Mustacchi void 267*35786f68SRobert Mustacchi CvCaptureComments ( 268*35786f68SRobert Mustacchi ACPI_WALK_STATE *WalkState); 269*35786f68SRobert Mustacchi 270*35786f68SRobert Mustacchi void 271*35786f68SRobert Mustacchi CvTransferComments ( 272*35786f68SRobert Mustacchi ACPI_PARSE_OBJECT *Op); 273*35786f68SRobert Mustacchi 274*35786f68SRobert Mustacchi /* 275*35786f68SRobert Mustacchi * cvdisasm 276*35786f68SRobert Mustacchi */ 277*35786f68SRobert Mustacchi void 278*35786f68SRobert Mustacchi CvSwitchFiles ( 279*35786f68SRobert Mustacchi UINT32 level, 280*35786f68SRobert Mustacchi ACPI_PARSE_OBJECT *op); 281*35786f68SRobert Mustacchi 282*35786f68SRobert Mustacchi BOOLEAN 283*35786f68SRobert Mustacchi CvFileHasSwitched ( 284*35786f68SRobert Mustacchi ACPI_PARSE_OBJECT *Op); 285*35786f68SRobert Mustacchi 286*35786f68SRobert Mustacchi 287*35786f68SRobert Mustacchi void 288*35786f68SRobert Mustacchi CvCloseParenWriteComment ( 289*35786f68SRobert Mustacchi ACPI_PARSE_OBJECT *Op, 290*35786f68SRobert Mustacchi UINT32 Level); 291*35786f68SRobert Mustacchi 292*35786f68SRobert Mustacchi void 293*35786f68SRobert Mustacchi CvCloseBraceWriteComment ( 294*35786f68SRobert Mustacchi ACPI_PARSE_OBJECT *Op, 295*35786f68SRobert Mustacchi UINT32 Level); 296*35786f68SRobert Mustacchi 297*35786f68SRobert Mustacchi void 298*35786f68SRobert Mustacchi CvPrintOneCommentList ( 299*35786f68SRobert Mustacchi ACPI_COMMENT_NODE *CommentList, 300*35786f68SRobert Mustacchi UINT32 Level); 301*35786f68SRobert Mustacchi 302*35786f68SRobert Mustacchi void 303*35786f68SRobert Mustacchi CvPrintOneCommentType ( 304*35786f68SRobert Mustacchi ACPI_PARSE_OBJECT *Op, 305*35786f68SRobert Mustacchi UINT8 CommentType, 306*35786f68SRobert Mustacchi char* EndStr, 307*35786f68SRobert Mustacchi UINT32 Level); 308*35786f68SRobert Mustacchi 309*35786f68SRobert Mustacchi 310*35786f68SRobert Mustacchi #endif 311*35786f68SRobert Mustacchi 312*35786f68SRobert Mustacchi #endif /* _ACCONVERT */ 313