drivers/acpi/tools/acpidump/acpidump.h

   1 /******************************************************************************
   2  *
   3  * Module Name: acpidump.h - Include file for AcpiDump utility
   4  *
   5  *****************************************************************************/
   6
   7 /******************************************************************************
   8  *
   9  * 1. Copyright Notice
  10  *
  11  * Some or all of this work - Copyright (c) 1999 - 2015, Intel Corp.
  12  * All rights reserved.
  13  *
  14  * 2. License
  15  *
  16  * 2.1. This is your license from Intel Corp. under its intellectual property
  17  * rights. You may have additional license terms from the party that provided
  18  * you this software, covering your right to use that party's intellectual
  19  * property rights.
  20  *
  21  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
  22  * copy of the source code appearing in this file ("Covered Code") an
  23  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
  24  * base code distributed originally by Intel ("Original Intel Code") to copy,
  25  * make derivatives, distribute, use and display any portion of the Covered
  26  * Code in any form, with the right to sublicense such rights; and
  27  *
  28  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
  29  * license (with the right to sublicense), under only those claims of Intel
  30  * patents that are infringed by the Original Intel Code, to make, use, sell,
  31  * offer to sell, and import the Covered Code and derivative works thereof
  32  * solely to the minimum extent necessary to exercise the above copyright
  33  * license, and in no event shall the patent license extend to any additions
  34  * to or modifications of the Original Intel Code. No other license or right
  35  * is granted directly or by implication, estoppel or otherwise;
  36  *
  37  * The above copyright and patent license is granted only if the following
  38  * conditions are met:
  39  *
  40  * 3. Conditions
  41  *
  42  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
  43  * Redistribution of source code of any substantial portion of the Covered
  44  * Code or modification with rights to further distribute source must include
  45  * the above Copyright Notice, the above License, this list of Conditions,
  46  * and the following Disclaimer and Export Compliance provision. In addition,
  47  * Licensee must cause all Covered Code to which Licensee contributes to
  48  * contain a file documenting the changes Licensee made to create that Covered
  49  * Code and the date of any change. Licensee must include in that file the
  50  * documentation of any changes made by any predecessor Licensee. Licensee
  51  * must include a prominent statement that the modification is derived,
  52  * directly or indirectly, from Original Intel Code.
  53  *
  54  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
  55  * Redistribution of source code of any substantial portion of the Covered
  56  * Code or modification without rights to further distribute source must
  57  * include the following Disclaimer and Export Compliance provision in the
  58  * documentation and/or other materials provided with distribution. In
  59  * addition, Licensee may not authorize further sublicense of source of any
  60  * portion of the Covered Code, and must include terms to the effect that the
  61  * license from Licensee to its licensee is limited to the intellectual
  62  * property embodied in the software Licensee provides to its licensee, and
  63  * not to intellectual property embodied in modifications its licensee may
  64  * make.
  65  *
  66  * 3.3. Redistribution of Executable. Redistribution in executable form of any
  67  * substantial portion of the Covered Code or modification must reproduce the
  68  * above Copyright Notice, and the following Disclaimer and Export Compliance
  69  * provision in the documentation and/or other materials provided with the
  70  * distribution.
  71  *
  72  * 3.4. Intel retains all right, title, and interest in and to the Original
  73  * Intel Code.
  74  *
  75  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
  76  * Intel shall be used in advertising or otherwise to promote the sale, use or
  77  * other dealings in products derived from or relating to the Covered Code
  78  * without prior written authorization from Intel.
  79  *
  80  * 4. Disclaimer and Export Compliance
  81  *
  82  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
  83  * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
  84  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
  85  * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
  86  * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
  87  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
  88  * PARTICULAR PURPOSE.
  89  *
  90  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
  91  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
  92  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
  93  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
  94  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
  95  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
  96  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
  97  * LIMITED REMEDY.
  98  *
  99  * 4.3. Licensee shall not export, either directly or indirectly, any of this
 100  * software or system incorporating such software without first obtaining any
 101  * required license or other approval from the U. S. Department of Commerce or
 102  * any other agency or department of the United States Government. In the
 103  * event Licensee exports any such software from the United States or
 104  * re-exports any such software from a foreign destination, Licensee shall
 105  * ensure that the distribution and export/re-export of the software is in
 106  * compliance with all laws, regulations, orders, or other restrictions of the
 107  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
 108  * any of its subsidiaries will export/re-export any technical data, process,
 109  * software, or service, directly or indirectly, to any country for which the
 110  * United States government or any agency thereof requires an export license,
 111  * other governmental approval, or letter of assurance, without first obtaining
 112  * such license, approval or letter.
 113  *
 114  *****************************************************************************/
 115
 116 /*
 117  * Global variables. Defined in main.c only, externed in all other files
 118  */
 119 #ifdef _DECLARE_GLOBALS
 120 #define EXTERN
 121 #define INIT_GLOBAL(a,b)        a=b
 122 #else
 123 #define EXTERN                  extern
 124 #define INIT_GLOBAL(a,b)        a
 125 #endif
 126
 127 #include "acpi.h"
 128 #include "accommon.h"
 129 #include "actables.h"
 130
 131 #include <stdio.h>
 132 #include <fcntl.h>
 133 #include <errno.h>
 134 #include <sys/stat.h>
 135
 136
 137 /* Globals */
 138
 139 EXTERN BOOLEAN              INIT_GLOBAL (Gbl_SummaryMode, FALSE);
 140 EXTERN BOOLEAN              INIT_GLOBAL (Gbl_VerboseMode, FALSE);
 141 EXTERN BOOLEAN              INIT_GLOBAL (Gbl_BinaryMode, FALSE);
 142 EXTERN BOOLEAN              INIT_GLOBAL (Gbl_DumpCustomizedTables, FALSE);
 143 EXTERN BOOLEAN              INIT_GLOBAL (Gbl_DoNotDumpXsdt, FALSE);
 144 EXTERN ACPI_FILE            INIT_GLOBAL (Gbl_OutputFile, NULL);
 145 EXTERN char                 INIT_GLOBAL (*Gbl_OutputFilename, NULL);
 146 EXTERN UINT64               INIT_GLOBAL (Gbl_RsdpBase, 0);
 147
 148 /* Globals required for use with ACPICA modules */
 149
 150 #ifdef _DECLARE_GLOBALS
 151 UINT8                       AcpiGbl_IntegerByteWidth = 8;
 152 #endif
 153
 154 /* Action table used to defer requested options */
 155
 156 typedef struct ap_dump_action
 157 {
 158     char                    *Argument;
 159     UINT32                  ToBeDone;
 160
 161 } AP_DUMP_ACTION;
 162
 163 #define AP_MAX_ACTIONS              32
 164
 165 #define AP_DUMP_ALL_TABLES          0
 166 #define AP_DUMP_TABLE_BY_ADDRESS    1
 167 #define AP_DUMP_TABLE_BY_NAME       2
 168 #define AP_DUMP_TABLE_BY_FILE       3
 169
 170 #define AP_MAX_ACPI_FILES           256 /* Prevent infinite loops */
 171
 172 /* Minimum FADT sizes for various table addresses */
 173
 174 #define MIN_FADT_FOR_DSDT           (ACPI_FADT_OFFSET (Dsdt) + sizeof (UINT32))
 175 #define MIN_FADT_FOR_FACS           (ACPI_FADT_OFFSET (Facs) + sizeof (UINT32))
 176 #define MIN_FADT_FOR_XDSDT          (ACPI_FADT_OFFSET (XDsdt) + sizeof (UINT64))
 177 #define MIN_FADT_FOR_XFACS          (ACPI_FADT_OFFSET (XFacs) + sizeof (UINT64))
 178
 179
 180 /*
 181  * apdump - Table get/dump routines
 182  */
 183 int
 184 ApDumpTableFromFile (
 185     char                    *Pathname);
 186
 187 int
 188 ApDumpTableByName (
 189     char                    *Signature);
 190
 191 int
 192 ApDumpTableByAddress (
 193     char                    *AsciiAddress);
 194
 195 int
 196 ApDumpAllTables (
 197     void);
 198
 199 BOOLEAN
 200 ApIsValidHeader (
 201     ACPI_TABLE_HEADER       *Table);
 202
 203 BOOLEAN
 204 ApIsValidChecksum (
 205     ACPI_TABLE_HEADER       *Table);
 206
 207 UINT32
 208 ApGetTableLength (
 209     ACPI_TABLE_HEADER       *Table);
 210
 211
 212 /*
 213  * apfiles - File I/O utilities
 214  */
 215 int
 216 ApOpenOutputFile (
 217     char                    *Pathname);
 218
 219 int
 220 ApWriteToBinaryFile (
 221     ACPI_TABLE_HEADER       *Table,
 222     UINT32                  Instance);
 223
 224 ACPI_TABLE_HEADER *
 225 ApGetTableFromFile (
 226     char                    *Pathname,
 227     UINT32                  *FileSize);