Home | History | Annotate | Line # | Download | only in acpidump
acpidump.h revision 1.1.1.11 
      1 /******************************************************************************
      2  *
      3  * Module Name: acpidump.h - Include file for AcpiDump utility
      4  *
      5  *****************************************************************************/
      6 
      7 /*
      8  * Copyright (C) 2000 - 2021, Intel Corp.
      9  * All rights reserved.
     10  *
     11  * Redistribution and use in source and binary forms, with or without
     12  * modification, are permitted provided that the following conditions
     13  * are met:
     14  * 1. Redistributions of source code must retain the above copyright
     15  *    notice, this list of conditions, and the following disclaimer,
     16  *    without modification.
     17  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
     18  *    substantially similar to the "NO WARRANTY" disclaimer below
     19  *    ("Disclaimer") and any redistribution must be conditioned upon
     20  *    including a substantially similar Disclaimer requirement for further
     21  *    binary redistribution.
     22  * 3. Neither the names of the above-listed copyright holders nor the names
     23  *    of any contributors may be used to endorse or promote products derived
     24  *    from this software without specific prior written permission.
     25  *
     26  * Alternatively, this software may be distributed under the terms of the
     27  * GNU General Public License ("GPL") version 2 as published by the Free
     28  * Software Foundation.
     29  *
     30  * NO WARRANTY
     31  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
     32  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
     33  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
     34  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
     35  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     36  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
     37  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     38  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
     39  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
     40  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     41  * POSSIBILITY OF SUCH DAMAGES.
     42  */
     43 
     44 /*
     45  * Global variables. Defined in main.c only, externed in all other files
     46  */
     47 #ifdef _DECLARE_GLOBALS
     48 #define EXTERN
     49 #define INIT_GLOBAL(a,b)        a=b
     50 #else
     51 #define EXTERN                  extern
     52 #define INIT_GLOBAL(a,b)        a
     53 #endif
     54 
     55 #include "acpi.h"
     56 #include "accommon.h"
     57 #include "actables.h"
     58 #include "acapps.h"
     59 
     60 /* Globals */
     61 
     62 EXTERN BOOLEAN              INIT_GLOBAL (Gbl_SummaryMode, FALSE);
     63 EXTERN BOOLEAN              INIT_GLOBAL (Gbl_VerboseMode, FALSE);
     64 EXTERN BOOLEAN              INIT_GLOBAL (Gbl_BinaryMode, FALSE);
     65 EXTERN BOOLEAN              INIT_GLOBAL (Gbl_DumpCustomizedTables, TRUE);
     66 EXTERN BOOLEAN              INIT_GLOBAL (Gbl_DoNotDumpXsdt, FALSE);
     67 EXTERN ACPI_FILE            INIT_GLOBAL (Gbl_OutputFile, NULL);
     68 EXTERN char                 INIT_GLOBAL (*Gbl_OutputFilename, NULL);
     69 EXTERN UINT64               INIT_GLOBAL (Gbl_RsdpBase, 0);
     70 
     71 /* Action table used to defer requested options */
     72 
     73 typedef struct ap_dump_action
     74 {
     75     char                    *Argument;
     76     UINT32                  ToBeDone;
     77 
     78 } AP_DUMP_ACTION;
     79 
     80 #define AP_MAX_ACTIONS              32
     81 
     82 #define AP_DUMP_ALL_TABLES          0
     83 #define AP_DUMP_TABLE_BY_ADDRESS    1
     84 #define AP_DUMP_TABLE_BY_NAME       2
     85 #define AP_DUMP_TABLE_BY_FILE       3
     86 
     87 #define AP_MAX_ACPI_FILES           256 /* Prevent infinite loops */
     88 
     89 /* Minimum FADT sizes for various table addresses */
     90 
     91 #define MIN_FADT_FOR_DSDT           (ACPI_FADT_OFFSET (Dsdt) + sizeof (UINT32))
     92 #define MIN_FADT_FOR_FACS           (ACPI_FADT_OFFSET (Facs) + sizeof (UINT32))
     93 #define MIN_FADT_FOR_XDSDT          (ACPI_FADT_OFFSET (XDsdt) + sizeof (UINT64))
     94 #define MIN_FADT_FOR_XFACS          (ACPI_FADT_OFFSET (XFacs) + sizeof (UINT64))
     95 
     96 
     97 /*
     98  * apdump - Table get/dump routines
     99  */
    100 int
    101 ApDumpTableFromFile (
    102     char                    *Pathname);
    103 
    104 int
    105 ApDumpTableByName (
    106     char                    *Signature);
    107 
    108 int
    109 ApDumpTableByAddress (
    110     char                    *AsciiAddress);
    111 
    112 int
    113 ApDumpAllTables (
    114     void);
    115 
    116 BOOLEAN
    117 ApIsValidHeader (
    118     ACPI_TABLE_HEADER       *Table);
    119 
    120 BOOLEAN
    121 ApIsValidChecksum (
    122     ACPI_TABLE_HEADER       *Table);
    123 
    124 UINT32
    125 ApGetTableLength (
    126     ACPI_TABLE_HEADER       *Table);
    127 
    128 
    129 /*
    130  * apfiles - File I/O utilities
    131  */
    132 int
    133 ApOpenOutputFile (
    134     char                    *Pathname);
    135 
    136 int
    137 ApWriteToBinaryFile (
    138     ACPI_TABLE_HEADER       *Table,
    139     UINT32                  Instance);
    140 
    141 ACPI_TABLE_HEADER *
    142 ApGetTableFromFile (
    143     char                    *Pathname,
    144     UINT32                  *FileSize);
    145