Back to home page

LXR

 
 

    


File indexing completed on 2025-05-11 08:23:41

0001 /******************************************************************************
0002  *
0003  * Module Name: acapps - common include for ACPI applications/tools
0004  *
0005  *****************************************************************************/
0006 
0007 /******************************************************************************
0008  *
0009  * 1. Copyright Notice
0010  *
0011  * Some or all of this work - Copyright (c) 1999 - 2024, Intel Corp.
0012  * All rights reserved.
0013  *
0014  * 2. License
0015  *
0016  * 2.1. This is your license from Intel Corp. under its intellectual property
0017  * rights. You may have additional license terms from the party that provided
0018  * you this software, covering your right to use that party's intellectual
0019  * property rights.
0020  *
0021  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
0022  * copy of the source code appearing in this file ("Covered Code") an
0023  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
0024  * base code distributed originally by Intel ("Original Intel Code") to copy,
0025  * make derivatives, distribute, use and display any portion of the Covered
0026  * Code in any form, with the right to sublicense such rights; and
0027  *
0028  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
0029  * license (with the right to sublicense), under only those claims of Intel
0030  * patents that are infringed by the Original Intel Code, to make, use, sell,
0031  * offer to sell, and import the Covered Code and derivative works thereof
0032  * solely to the minimum extent necessary to exercise the above copyright
0033  * license, and in no event shall the patent license extend to any additions
0034  * to or modifications of the Original Intel Code. No other license or right
0035  * is granted directly or by implication, estoppel or otherwise;
0036  *
0037  * The above copyright and patent license is granted only if the following
0038  * conditions are met:
0039  *
0040  * 3. Conditions
0041  *
0042  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
0043  * Redistribution of source code of any substantial portion of the Covered
0044  * Code or modification with rights to further distribute source must include
0045  * the above Copyright Notice, the above License, this list of Conditions,
0046  * and the following Disclaimer and Export Compliance provision. In addition,
0047  * Licensee must cause all Covered Code to which Licensee contributes to
0048  * contain a file documenting the changes Licensee made to create that Covered
0049  * Code and the date of any change. Licensee must include in that file the
0050  * documentation of any changes made by any predecessor Licensee. Licensee
0051  * must include a prominent statement that the modification is derived,
0052  * directly or indirectly, from Original Intel Code.
0053  *
0054  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
0055  * Redistribution of source code of any substantial portion of the Covered
0056  * Code or modification without rights to further distribute source must
0057  * include the following Disclaimer and Export Compliance provision in the
0058  * documentation and/or other materials provided with distribution. In
0059  * addition, Licensee may not authorize further sublicense of source of any
0060  * portion of the Covered Code, and must include terms to the effect that the
0061  * license from Licensee to its licensee is limited to the intellectual
0062  * property embodied in the software Licensee provides to its licensee, and
0063  * not to intellectual property embodied in modifications its licensee may
0064  * make.
0065  *
0066  * 3.3. Redistribution of Executable. Redistribution in executable form of any
0067  * substantial portion of the Covered Code or modification must reproduce the
0068  * above Copyright Notice, and the following Disclaimer and Export Compliance
0069  * provision in the documentation and/or other materials provided with the
0070  * distribution.
0071  *
0072  * 3.4. Intel retains all right, title, and interest in and to the Original
0073  * Intel Code.
0074  *
0075  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
0076  * Intel shall be used in advertising or otherwise to promote the sale, use or
0077  * other dealings in products derived from or relating to the Covered Code
0078  * without prior written authorization from Intel.
0079  *
0080  * 4. Disclaimer and Export Compliance
0081  *
0082  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
0083  * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
0084  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
0085  * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
0086  * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
0087  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
0088  * PARTICULAR PURPOSE.
0089  *
0090  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
0091  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
0092  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
0093  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
0094  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
0095  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
0096  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
0097  * LIMITED REMEDY.
0098  *
0099  * 4.3. Licensee shall not export, either directly or indirectly, any of this
0100  * software or system incorporating such software without first obtaining any
0101  * required license or other approval from the U. S. Department of Commerce or
0102  * any other agency or department of the United States Government. In the
0103  * event Licensee exports any such software from the United States or
0104  * re-exports any such software from a foreign destination, Licensee shall
0105  * ensure that the distribution and export/re-export of the software is in
0106  * compliance with all laws, regulations, orders, or other restrictions of the
0107  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
0108  * any of its subsidiaries will export/re-export any technical data, process,
0109  * software, or service, directly or indirectly, to any country for which the
0110  * United States government or any agency thereof requires an export license,
0111  * other governmental approval, or letter of assurance, without first obtaining
0112  * such license, approval or letter.
0113  *
0114  *****************************************************************************
0115  *
0116  * Alternatively, you may choose to be licensed under the terms of the
0117  * following license:
0118  *
0119  * Redistribution and use in source and binary forms, with or without
0120  * modification, are permitted provided that the following conditions
0121  * are met:
0122  * 1. Redistributions of source code must retain the above copyright
0123  *    notice, this list of conditions, and the following disclaimer,
0124  *    without modification.
0125  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
0126  *    substantially similar to the "NO WARRANTY" disclaimer below
0127  *    ("Disclaimer") and any redistribution must be conditioned upon
0128  *    including a substantially similar Disclaimer requirement for further
0129  *    binary redistribution.
0130  * 3. Neither the names of the above-listed copyright holders nor the names
0131  *    of any contributors may be used to endorse or promote products derived
0132  *    from this software without specific prior written permission.
0133  *
0134  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
0135  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
0136  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
0137  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
0138  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
0139  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
0140  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
0141  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
0142  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
0143  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
0144  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
0145  *
0146  * Alternatively, you may choose to be licensed under the terms of the
0147  * GNU General Public License ("GPL") version 2 as published by the Free
0148  * Software Foundation.
0149  *
0150  *****************************************************************************/
0151 
0152 #ifndef _ACCONVERT
0153 #define _ACCONVERT
0154 
0155 /* Definitions for comment state */
0156 
0157 #define ASL_COMMENT_STANDARD    1
0158 #define ASLCOMMENT_INLINE       2
0159 #define ASL_COMMENT_OPEN_PAREN  3
0160 #define ASL_COMMENT_CLOSE_PAREN 4
0161 #define ASL_COMMENT_CLOSE_BRACE 5
0162 
0163 /* Definitions for comment print function*/
0164 
0165 #define AML_COMMENT_STANDARD    1
0166 #define AMLCOMMENT_INLINE       2
0167 #define AML_COMMENT_END_NODE    3
0168 #define AML_NAMECOMMENT         4
0169 #define AML_COMMENT_CLOSE_BRACE 5
0170 #define AML_COMMENT_ENDBLK      6
0171 #define AML_COMMENT_INCLUDE     7
0172 
0173 
0174 #ifdef ACPI_ASL_COMPILER
0175 /*
0176  * cvcompiler
0177  */
0178 void
0179 CvProcessComment (
0180     ASL_COMMENT_STATE       CurrentState,
0181     char                    *StringBuffer,
0182     int                     c1);
0183 
0184 void
0185 CvProcessCommentType2 (
0186     ASL_COMMENT_STATE       CurrentState,
0187     char                    *StringBuffer);
0188 
0189 UINT32
0190 CvCalculateCommentLengths(
0191    ACPI_PARSE_OBJECT        *Op);
0192 
0193 void
0194 CvProcessCommentState (
0195     char                    input);
0196 
0197 char*
0198 CvAppendInlineComment (
0199     char                    *InlineComment,
0200     char                    *ToAdd);
0201 
0202 void
0203 CvAddToCommentList (
0204     char*                   ToAdd);
0205 
0206 void
0207 CvPlaceComment (
0208     UINT8                   Type,
0209     char                    *CommentString);
0210 
0211 UINT32
0212 CvParseOpBlockType (
0213     ACPI_PARSE_OBJECT       *Op);
0214 
0215 ACPI_COMMENT_NODE*
0216 CvCommentNodeCalloc (
0217     void);
0218 
0219 void
0220 CgWriteAmlDefBlockComment (
0221     ACPI_PARSE_OBJECT       *Op);
0222 
0223 void
0224 CgWriteOneAmlComment (
0225     ACPI_PARSE_OBJECT       *Op,
0226     char*                   CommentToPrint,
0227     UINT8                   InputOption);
0228 
0229 void
0230 CgWriteAmlComment (
0231     ACPI_PARSE_OBJECT       *Op);
0232 
0233 
0234 /*
0235  * cvparser
0236  */
0237 void
0238 CvInitFileTree (
0239     ACPI_TABLE_HEADER       *Table,
0240     FILE                    *RootFile);
0241 
0242 void
0243 CvClearOpComments (
0244     ACPI_PARSE_OBJECT       *Op);
0245 
0246 ACPI_FILE_NODE*
0247 CvFilenameExists (
0248     char                    *Filename,
0249     ACPI_FILE_NODE           *Head);
0250 
0251 void
0252 CvLabelFileNode (
0253     ACPI_PARSE_OBJECT       *Op);
0254 
0255 void
0256 CvCaptureListComments (
0257     ACPI_PARSE_STATE        *ParserState,
0258     ACPI_COMMENT_NODE       *ListHead,
0259     ACPI_COMMENT_NODE       *ListTail);
0260 
0261 void
0262 CvCaptureCommentsOnly (
0263     ACPI_PARSE_STATE        *ParserState);
0264 
0265 void
0266 CvCaptureComments (
0267     ACPI_WALK_STATE         *WalkState);
0268 
0269 void
0270 CvTransferComments (
0271     ACPI_PARSE_OBJECT       *Op);
0272 
0273 /*
0274  * cvdisasm
0275  */
0276 void
0277 CvSwitchFiles (
0278     UINT32                  level,
0279     ACPI_PARSE_OBJECT       *op);
0280 
0281 BOOLEAN
0282 CvFileHasSwitched (
0283     ACPI_PARSE_OBJECT       *Op);
0284 
0285 
0286 void
0287 CvCloseParenWriteComment (
0288     ACPI_PARSE_OBJECT       *Op,
0289     UINT32                  Level);
0290 
0291 void
0292 CvCloseBraceWriteComment (
0293     ACPI_PARSE_OBJECT       *Op,
0294     UINT32                  Level);
0295 
0296 void
0297 CvPrintOneCommentList (
0298     ACPI_COMMENT_NODE       *CommentList,
0299     UINT32                  Level);
0300 
0301 void
0302 CvPrintOneCommentType (
0303     ACPI_PARSE_OBJECT       *Op,
0304     UINT8                   CommentType,
0305     char*                   EndStr,
0306     UINT32                  Level);
0307 
0308 
0309 #endif
0310 
0311 #endif /* _ACCONVERT */