acpi/acpica/acapps.h

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 _ACAPPS
0153 #define _ACAPPS
0154
0155 #ifdef ACPI_USE_STANDARD_HEADERS
0156 #include <sys/stat.h>
0157 #endif /* ACPI_USE_STANDARD_HEADERS */
0158
0159 /* Common info for tool signons */
0160
0161 #define ACPICA_NAME                 "Intel ACPI Component Architecture"
0162 #define ACPICA_COPYRIGHT            "Copyright (c) 2000 - 2023 Intel Corporation"
0163
0164 #if ACPI_MACHINE_WIDTH == 64
0165 #define ACPI_WIDTH          " (64-bit version)"
0166
0167 #elif ACPI_MACHINE_WIDTH == 32
0168 #define ACPI_WIDTH          " (32-bit version)"
0169
0170 #else
0171 #error unknown ACPI_MACHINE_WIDTH
0172 #define ACPI_WIDTH          " (unknown bit width, not 32 or 64)"
0173
0174 #endif
0175
0176 /* Macros for signons and file headers */
0177
0178 #define ACPI_COMMON_SIGNON(UtilityName) \
0179     "\n%s\n%s version %8.8X\n%s\n\n", \
0180     ACPICA_NAME, \
0181     UtilityName, ((UINT32) ACPI_CA_VERSION), \
0182     ACPICA_COPYRIGHT
0183
0184 #define ACPI_COMMON_HEADER(UtilityName, Prefix) \
0185     "%s%s\n%s%s version %8.8X%s\n%s%s\n%s\n", \
0186     Prefix, ACPICA_NAME, \
0187     Prefix, UtilityName, ((UINT32) ACPI_CA_VERSION), ACPI_WIDTH, \
0188     Prefix, ACPICA_COPYRIGHT, \
0189     Prefix
0190
0191 #define ACPI_COMMON_BUILD_TIME \
0192     "Build date/time: %s %s\n", __DATE__, __TIME__
0193
0194 /* Macros for usage messages */
0195
0196 #define ACPI_USAGE_HEADER(Usage) \
0197     printf ("Usage: %s\nOptions:\n", Usage);
0198
0199 #define ACPI_USAGE_TEXT(Description) \
0200     printf (Description);
0201
0202 #define ACPI_OPTION(Name, Description) \
0203     printf ("  %-20s%s\n", Name, Description);
0204
0205
0206 /* Check for unexpected exceptions */
0207
0208 #define ACPI_CHECK_STATUS(Name, Status, Expected) \
0209     if (Status != Expected) \
0210     { \
0211         AcpiOsPrintf ("Unexpected %s from %s (%s-%d)\n", \
0212             AcpiFormatException (Status), #Name, _AcpiModuleName, __LINE__); \
0213     }
0214
0215 /* Check for unexpected non-AE_OK errors */
0216
0217
0218 #define ACPI_CHECK_OK(Name, Status)   ACPI_CHECK_STATUS (Name, Status, AE_OK);
0219
0220 #define FILE_SUFFIX_DISASSEMBLY     "dsl"
0221 #define FILE_SUFFIX_BINARY_TABLE    ".dat" /* Needs the dot */
0222
0223
0224 /* acfileio */
0225
0226 ACPI_STATUS
0227 AcGetAllTablesFromFile (
0228     char                    *Filename,
0229     UINT8                   GetOnlyAmlTables,
0230     ACPI_NEW_TABLE_DESC     **ReturnListHead);
0231
0232 void
0233 AcDeleteTableList (
0234     ACPI_NEW_TABLE_DESC     *ListHead);
0235
0236 BOOLEAN
0237 AcIsFileBinary (
0238     FILE                    *File);
0239
0240 ACPI_STATUS
0241 AcValidateTableHeader (
0242     FILE                    *File,
0243     long                    TableOffset);
0244
0245
0246 /* Values for GetOnlyAmlTables */
0247
0248 #define ACPI_GET_ONLY_AML_TABLES    TRUE
0249 #define ACPI_GET_ALL_TABLES         FALSE
0250
0251
0252 /*
0253  * getopt
0254  */
0255 int
0256 AcpiGetopt(
0257     int                     argc,
0258     char                    **argv,
0259     char                    *opts);
0260
0261 int
0262 AcpiGetoptArgument (
0263     int                     argc,
0264     char                    **argv);
0265
0266 extern int                  AcpiGbl_Optind;
0267 extern int                  AcpiGbl_Opterr;
0268 extern int                  AcpiGbl_SubOptChar;
0269 extern char                 *AcpiGbl_Optarg;
0270
0271
0272 /*
0273  * cmfsize - Common get file size function
0274  */
0275 UINT32
0276 CmGetFileSize (
0277     ACPI_FILE               File);
0278
0279
0280 /*
0281  * adwalk
0282  */
0283 void
0284 AcpiDmCrossReferenceNamespace (
0285     ACPI_PARSE_OBJECT       *ParseTreeRoot,
0286     ACPI_NAMESPACE_NODE     *NamespaceRoot,
0287     ACPI_OWNER_ID           OwnerId);
0288
0289 void
0290 AcpiDmDumpTree (
0291     ACPI_PARSE_OBJECT       *Origin);
0292
0293 void
0294 AcpiDmFindOrphanMethods (
0295     ACPI_PARSE_OBJECT       *Origin);
0296
0297 void
0298 AcpiDmFinishNamespaceLoad (
0299     ACPI_PARSE_OBJECT       *ParseTreeRoot,
0300     ACPI_NAMESPACE_NODE     *NamespaceRoot,
0301     ACPI_OWNER_ID           OwnerId);
0302
0303 void
0304 AcpiDmConvertParseObjects (
0305     ACPI_PARSE_OBJECT       *ParseTreeRoot,
0306     ACPI_NAMESPACE_NODE     *NamespaceRoot);
0307
0308
0309 /*
0310  * adfile
0311  */
0312 ACPI_STATUS
0313 AdInitialize (
0314     void);
0315
0316 char *
0317 FlGenerateFilename (
0318     char                    *InputFilename,
0319     char                    *Suffix);
0320
0321 ACPI_STATUS
0322 FlSplitInputPathname (
0323     char                    *InputPath,
0324     char                    **OutDirectoryPath,
0325     char                    **OutFilename);
0326
0327 char *
0328 FlGetFileBasename (
0329     char                    *FilePathname);
0330
0331 char *
0332 AdGenerateFilename (
0333     char                    *Prefix,
0334     char                    *TableId);
0335
0336 void
0337 AdWriteTable (
0338     ACPI_TABLE_HEADER       *Table,
0339     UINT32                  Length,
0340     char                    *TableName,
0341     char                    *OemTableId);
0342
0343 #endif /* _ACAPPS */