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