Home | History | Annotate | Line # | Download | only in include
      1   1.1    jruoho /******************************************************************************
      2   1.1    jruoho  *
      3   1.1    jruoho  * Module Name: acapps - common include for ACPI applications/tools
      4   1.1    jruoho  *
      5   1.1    jruoho  *****************************************************************************/
      6   1.1    jruoho 
      7  1.21  christos /******************************************************************************
      8  1.21  christos  *
      9  1.21  christos  * 1. Copyright Notice
     10  1.21  christos  *
     11  1.23  christos  * Some or all of this work - Copyright (c) 1999 - 2025, Intel Corp.
     12   1.1    jruoho  * All rights reserved.
     13   1.1    jruoho  *
     14  1.21  christos  * 2. License
     15  1.21  christos  *
     16  1.21  christos  * 2.1. This is your license from Intel Corp. under its intellectual property
     17  1.21  christos  * rights. You may have additional license terms from the party that provided
     18  1.21  christos  * you this software, covering your right to use that party's intellectual
     19  1.21  christos  * property rights.
     20  1.21  christos  *
     21  1.21  christos  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
     22  1.21  christos  * copy of the source code appearing in this file ("Covered Code") an
     23  1.21  christos  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
     24  1.21  christos  * base code distributed originally by Intel ("Original Intel Code") to copy,
     25  1.21  christos  * make derivatives, distribute, use and display any portion of the Covered
     26  1.21  christos  * Code in any form, with the right to sublicense such rights; and
     27  1.21  christos  *
     28  1.21  christos  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
     29  1.21  christos  * license (with the right to sublicense), under only those claims of Intel
     30  1.21  christos  * patents that are infringed by the Original Intel Code, to make, use, sell,
     31  1.21  christos  * offer to sell, and import the Covered Code and derivative works thereof
     32  1.21  christos  * solely to the minimum extent necessary to exercise the above copyright
     33  1.21  christos  * license, and in no event shall the patent license extend to any additions
     34  1.21  christos  * to or modifications of the Original Intel Code. No other license or right
     35  1.21  christos  * is granted directly or by implication, estoppel or otherwise;
     36  1.21  christos  *
     37  1.21  christos  * The above copyright and patent license is granted only if the following
     38  1.21  christos  * conditions are met:
     39  1.21  christos  *
     40  1.21  christos  * 3. Conditions
     41  1.21  christos  *
     42  1.21  christos  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
     43  1.21  christos  * Redistribution of source code of any substantial portion of the Covered
     44  1.21  christos  * Code or modification with rights to further distribute source must include
     45  1.21  christos  * the above Copyright Notice, the above License, this list of Conditions,
     46  1.21  christos  * and the following Disclaimer and Export Compliance provision. In addition,
     47  1.21  christos  * Licensee must cause all Covered Code to which Licensee contributes to
     48  1.21  christos  * contain a file documenting the changes Licensee made to create that Covered
     49  1.21  christos  * Code and the date of any change. Licensee must include in that file the
     50  1.21  christos  * documentation of any changes made by any predecessor Licensee. Licensee
     51  1.21  christos  * must include a prominent statement that the modification is derived,
     52  1.21  christos  * directly or indirectly, from Original Intel Code.
     53  1.21  christos  *
     54  1.21  christos  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
     55  1.21  christos  * Redistribution of source code of any substantial portion of the Covered
     56  1.21  christos  * Code or modification without rights to further distribute source must
     57  1.21  christos  * include the following Disclaimer and Export Compliance provision in the
     58  1.21  christos  * documentation and/or other materials provided with distribution. In
     59  1.21  christos  * addition, Licensee may not authorize further sublicense of source of any
     60  1.21  christos  * portion of the Covered Code, and must include terms to the effect that the
     61  1.21  christos  * license from Licensee to its licensee is limited to the intellectual
     62  1.21  christos  * property embodied in the software Licensee provides to its licensee, and
     63  1.21  christos  * not to intellectual property embodied in modifications its licensee may
     64  1.21  christos  * make.
     65  1.21  christos  *
     66  1.21  christos  * 3.3. Redistribution of Executable. Redistribution in executable form of any
     67  1.21  christos  * substantial portion of the Covered Code or modification must reproduce the
     68  1.21  christos  * above Copyright Notice, and the following Disclaimer and Export Compliance
     69  1.21  christos  * provision in the documentation and/or other materials provided with the
     70  1.21  christos  * distribution.
     71  1.21  christos  *
     72  1.21  christos  * 3.4. Intel retains all right, title, and interest in and to the Original
     73  1.21  christos  * Intel Code.
     74  1.21  christos  *
     75  1.21  christos  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
     76  1.21  christos  * Intel shall be used in advertising or otherwise to promote the sale, use or
     77  1.21  christos  * other dealings in products derived from or relating to the Covered Code
     78  1.21  christos  * without prior written authorization from Intel.
     79  1.21  christos  *
     80  1.21  christos  * 4. Disclaimer and Export Compliance
     81  1.21  christos  *
     82  1.21  christos  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
     83  1.21  christos  * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
     84  1.21  christos  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
     85  1.21  christos  * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
     86  1.21  christos  * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
     87  1.21  christos  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
     88  1.21  christos  * PARTICULAR PURPOSE.
     89  1.21  christos  *
     90  1.21  christos  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
     91  1.21  christos  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
     92  1.21  christos  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
     93  1.21  christos  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
     94  1.21  christos  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
     95  1.21  christos  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
     96  1.21  christos  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
     97  1.21  christos  * LIMITED REMEDY.
     98  1.21  christos  *
     99  1.21  christos  * 4.3. Licensee shall not export, either directly or indirectly, any of this
    100  1.21  christos  * software or system incorporating such software without first obtaining any
    101  1.21  christos  * required license or other approval from the U. S. Department of Commerce or
    102  1.21  christos  * any other agency or department of the United States Government. In the
    103  1.21  christos  * event Licensee exports any such software from the United States or
    104  1.21  christos  * re-exports any such software from a foreign destination, Licensee shall
    105  1.21  christos  * ensure that the distribution and export/re-export of the software is in
    106  1.21  christos  * compliance with all laws, regulations, orders, or other restrictions of the
    107  1.21  christos  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
    108  1.21  christos  * any of its subsidiaries will export/re-export any technical data, process,
    109  1.21  christos  * software, or service, directly or indirectly, to any country for which the
    110  1.21  christos  * United States government or any agency thereof requires an export license,
    111  1.21  christos  * other governmental approval, or letter of assurance, without first obtaining
    112  1.21  christos  * such license, approval or letter.
    113  1.21  christos  *
    114  1.21  christos  *****************************************************************************
    115  1.21  christos  *
    116  1.21  christos  * Alternatively, you may choose to be licensed under the terms of the
    117  1.21  christos  * following license:
    118  1.21  christos  *
    119   1.2  christos  * Redistribution and use in source and binary forms, with or without
    120   1.2  christos  * modification, are permitted provided that the following conditions
    121   1.2  christos  * are met:
    122   1.2  christos  * 1. Redistributions of source code must retain the above copyright
    123   1.2  christos  *    notice, this list of conditions, and the following disclaimer,
    124   1.2  christos  *    without modification.
    125   1.2  christos  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
    126   1.2  christos  *    substantially similar to the "NO WARRANTY" disclaimer below
    127   1.2  christos  *    ("Disclaimer") and any redistribution must be conditioned upon
    128   1.2  christos  *    including a substantially similar Disclaimer requirement for further
    129   1.2  christos  *    binary redistribution.
    130   1.2  christos  * 3. Neither the names of the above-listed copyright holders nor the names
    131   1.2  christos  *    of any contributors may be used to endorse or promote products derived
    132   1.2  christos  *    from this software without specific prior written permission.
    133   1.2  christos  *
    134   1.2  christos  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
    135   1.2  christos  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
    136  1.17  christos  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
    137   1.2  christos  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
    138  1.21  christos  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
    139  1.21  christos  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
    140  1.21  christos  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
    141  1.21  christos  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
    142  1.21  christos  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
    143  1.21  christos  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
    144  1.21  christos  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
    145  1.21  christos  *
    146  1.21  christos  * Alternatively, you may choose to be licensed under the terms of the
    147  1.21  christos  * GNU General Public License ("GPL") version 2 as published by the Free
    148  1.21  christos  * Software Foundation.
    149  1.21  christos  *
    150  1.21  christos  *****************************************************************************/
    151   1.1    jruoho 
    152   1.1    jruoho #ifndef _ACAPPS
    153   1.1    jruoho #define _ACAPPS
    154   1.1    jruoho 
    155   1.9  christos #ifdef ACPI_USE_STANDARD_HEADERS
    156   1.9  christos #include <sys/stat.h>
    157   1.9  christos #endif /* ACPI_USE_STANDARD_HEADERS */
    158   1.1    jruoho 
    159   1.2  christos /* Common info for tool signons */
    160   1.2  christos 
    161   1.2  christos #define ACPICA_NAME                 "Intel ACPI Component Architecture"
    162  1.23  christos #define ACPICA_COPYRIGHT            "Copyright (c) 2000 - 2025 Intel Corporation"
    163   1.2  christos 
    164   1.2  christos #if ACPI_MACHINE_WIDTH == 64
    165  1.10  christos #define ACPI_WIDTH          " (64-bit version)"
    166   1.2  christos 
    167   1.2  christos #elif ACPI_MACHINE_WIDTH == 32
    168  1.10  christos #define ACPI_WIDTH          " (32-bit version)"
    169   1.2  christos 
    170   1.2  christos #else
    171   1.2  christos #error unknown ACPI_MACHINE_WIDTH
    172  1.10  christos #define ACPI_WIDTH          " (unknown bit width, not 32 or 64)"
    173   1.2  christos 
    174   1.2  christos #endif
    175   1.2  christos 
    176   1.2  christos /* Macros for signons and file headers */
    177   1.2  christos #ifdef ACPI_REPRO
    178  1.23  christos #define ACPI_DATE "7 Aug 2025"
    179  1.12  christos #define ACPI_TIME "00:00:00"
    180   1.2  christos #else
    181   1.2  christos #define ACPI_DATE __DATE__
    182  1.12  christos #define ACPI_TIME __TIME__
    183   1.2  christos #endif
    184   1.2  christos 
    185   1.2  christos #define ACPI_COMMON_SIGNON(UtilityName) \
    186  1.10  christos     "\n%s\n%s version %8.8X\n%s\n\n", \
    187   1.2  christos     ACPICA_NAME, \
    188  1.10  christos     UtilityName, ((UINT32) ACPI_CA_VERSION), \
    189   1.2  christos     ACPICA_COPYRIGHT
    190   1.2  christos 
    191   1.2  christos #define ACPI_COMMON_HEADER(UtilityName, Prefix) \
    192   1.7  christos     "%s%s\n%s%s version %8.8X%s\n%s%s\n%s\n", \
    193   1.2  christos     Prefix, ACPICA_NAME, \
    194   1.7  christos     Prefix, UtilityName, ((UINT32) ACPI_CA_VERSION), ACPI_WIDTH, \
    195   1.2  christos     Prefix, ACPICA_COPYRIGHT, \
    196   1.2  christos     Prefix
    197   1.2  christos 
    198  1.12  christos #define ACPI_COMMON_BUILD_TIME \
    199  1.12  christos     "Build date/time: %s %s\n", ACPI_DATE, ACPI_TIME
    200  1.12  christos 
    201   1.4  christos /* Macros for usage messages */
    202   1.4  christos 
    203   1.4  christos #define ACPI_USAGE_HEADER(Usage) \
    204   1.9  christos     printf ("Usage: %s\nOptions:\n", Usage);
    205   1.6  christos 
    206   1.6  christos #define ACPI_USAGE_TEXT(Description) \
    207   1.9  christos     printf (Description);
    208   1.4  christos 
    209   1.4  christos #define ACPI_OPTION(Name, Description) \
    210   1.9  christos     printf ("  %-20s%s\n", Name, Description);
    211   1.4  christos 
    212   1.4  christos 
    213   1.8  christos /* Check for unexpected exceptions */
    214   1.8  christos 
    215   1.8  christos #define ACPI_CHECK_STATUS(Name, Status, Expected) \
    216   1.8  christos     if (Status != Expected) \
    217   1.8  christos     { \
    218   1.8  christos         AcpiOsPrintf ("Unexpected %s from %s (%s-%d)\n", \
    219   1.8  christos             AcpiFormatException (Status), #Name, _AcpiModuleName, __LINE__); \
    220   1.8  christos     }
    221   1.8  christos 
    222   1.8  christos /* Check for unexpected non-AE_OK errors */
    223   1.8  christos 
    224   1.8  christos 
    225   1.8  christos #define ACPI_CHECK_OK(Name, Status)   ACPI_CHECK_STATUS (Name, Status, AE_OK);
    226   1.8  christos 
    227   1.1    jruoho #define FILE_SUFFIX_DISASSEMBLY     "dsl"
    228   1.8  christos #define FILE_SUFFIX_BINARY_TABLE    ".dat" /* Needs the dot */
    229   1.8  christos 
    230   1.8  christos 
    231   1.8  christos /* acfileio */
    232   1.8  christos 
    233   1.8  christos ACPI_STATUS
    234   1.8  christos AcGetAllTablesFromFile (
    235   1.8  christos     char                    *Filename,
    236   1.8  christos     UINT8                   GetOnlyAmlTables,
    237   1.8  christos     ACPI_NEW_TABLE_DESC     **ReturnListHead);
    238   1.8  christos 
    239  1.11  christos void
    240  1.11  christos AcDeleteTableList (
    241  1.11  christos     ACPI_NEW_TABLE_DESC     *ListHead);
    242  1.11  christos 
    243   1.8  christos BOOLEAN
    244   1.8  christos AcIsFileBinary (
    245   1.8  christos     FILE                    *File);
    246   1.8  christos 
    247   1.8  christos ACPI_STATUS
    248   1.8  christos AcValidateTableHeader (
    249   1.8  christos     FILE                    *File,
    250   1.8  christos     long                    TableOffset);
    251   1.8  christos 
    252   1.8  christos 
    253   1.8  christos /* Values for GetOnlyAmlTables */
    254   1.8  christos 
    255   1.8  christos #define ACPI_GET_ONLY_AML_TABLES    TRUE
    256   1.8  christos #define ACPI_GET_ALL_TABLES         FALSE
    257   1.1    jruoho 
    258   1.1    jruoho 
    259   1.1    jruoho /*
    260   1.1    jruoho  * getopt
    261   1.1    jruoho  */
    262   1.1    jruoho int
    263   1.1    jruoho AcpiGetopt(
    264   1.1    jruoho     int                     argc,
    265   1.1    jruoho     char                    **argv,
    266   1.1    jruoho     char                    *opts);
    267   1.1    jruoho 
    268   1.4  christos int
    269   1.4  christos AcpiGetoptArgument (
    270   1.4  christos     int                     argc,
    271   1.4  christos     char                    **argv);
    272   1.4  christos 
    273   1.1    jruoho extern int                  AcpiGbl_Optind;
    274   1.1    jruoho extern int                  AcpiGbl_Opterr;
    275   1.4  christos extern int                  AcpiGbl_SubOptChar;
    276   1.1    jruoho extern char                 *AcpiGbl_Optarg;
    277   1.1    jruoho 
    278   1.1    jruoho 
    279   1.6  christos /*
    280   1.6  christos  * cmfsize - Common get file size function
    281   1.6  christos  */
    282   1.6  christos UINT32
    283   1.6  christos CmGetFileSize (
    284   1.6  christos     ACPI_FILE               File);
    285   1.6  christos 
    286   1.6  christos 
    287   1.1    jruoho /*
    288   1.1    jruoho  * adwalk
    289   1.1    jruoho  */
    290   1.1    jruoho void
    291   1.1    jruoho AcpiDmCrossReferenceNamespace (
    292   1.1    jruoho     ACPI_PARSE_OBJECT       *ParseTreeRoot,
    293   1.1    jruoho     ACPI_NAMESPACE_NODE     *NamespaceRoot,
    294   1.1    jruoho     ACPI_OWNER_ID           OwnerId);
    295   1.1    jruoho 
    296   1.1    jruoho void
    297   1.1    jruoho AcpiDmDumpTree (
    298   1.1    jruoho     ACPI_PARSE_OBJECT       *Origin);
    299   1.1    jruoho 
    300   1.1    jruoho void
    301   1.1    jruoho AcpiDmFindOrphanMethods (
    302   1.1    jruoho     ACPI_PARSE_OBJECT       *Origin);
    303   1.1    jruoho 
    304   1.1    jruoho void
    305   1.1    jruoho AcpiDmFinishNamespaceLoad (
    306   1.1    jruoho     ACPI_PARSE_OBJECT       *ParseTreeRoot,
    307   1.1    jruoho     ACPI_NAMESPACE_NODE     *NamespaceRoot,
    308   1.1    jruoho     ACPI_OWNER_ID           OwnerId);
    309   1.1    jruoho 
    310   1.1    jruoho void
    311  1.11  christos AcpiDmConvertParseObjects (
    312   1.1    jruoho     ACPI_PARSE_OBJECT       *ParseTreeRoot,
    313   1.1    jruoho     ACPI_NAMESPACE_NODE     *NamespaceRoot);
    314   1.1    jruoho 
    315   1.1    jruoho 
    316   1.1    jruoho /*
    317   1.1    jruoho  * adfile
    318   1.1    jruoho  */
    319   1.1    jruoho ACPI_STATUS
    320   1.1    jruoho AdInitialize (
    321   1.1    jruoho     void);
    322   1.1    jruoho 
    323   1.1    jruoho char *
    324   1.1    jruoho FlGenerateFilename (
    325   1.1    jruoho     char                    *InputFilename,
    326   1.1    jruoho     char                    *Suffix);
    327   1.1    jruoho 
    328   1.1    jruoho ACPI_STATUS
    329   1.1    jruoho FlSplitInputPathname (
    330   1.1    jruoho     char                    *InputPath,
    331   1.1    jruoho     char                    **OutDirectoryPath,
    332   1.1    jruoho     char                    **OutFilename);
    333   1.1    jruoho 
    334   1.1    jruoho char *
    335  1.14  christos FlGetFileBasename (
    336  1.14  christos     char                    *FilePathname);
    337  1.14  christos 
    338  1.14  christos char *
    339   1.1    jruoho AdGenerateFilename (
    340   1.1    jruoho     char                    *Prefix,
    341   1.1    jruoho     char                    *TableId);
    342   1.1    jruoho 
    343   1.1    jruoho void
    344   1.1    jruoho AdWriteTable (
    345   1.1    jruoho     ACPI_TABLE_HEADER       *Table,
    346   1.1    jruoho     UINT32                  Length,
    347   1.1    jruoho     char                    *TableName,
    348   1.1    jruoho     char                    *OemTableId);
    349   1.1    jruoho 
    350   1.1    jruoho #endif /* _ACAPPS */
    351