sys/contrib/dev/acpica/source/tools/acpidump/acpidump.h

   1 /******************************************************************************
   2  *
   3  * Module Name: acpidump.h - Include file for AcpiDump utility
   4  *
   5  *****************************************************************************/
   6
   7 /*
   8  * Copyright (C) 2000 - 2015, 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 MERCHANTIBILITY 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
  59 #include <stdio.h>
  60 #include <fcntl.h>
  61 #include <errno.h>
  62 #include <sys/stat.h>
  63
  64
  65 /* Globals */
  66
  67 EXTERN BOOLEAN              INIT_GLOBAL (Gbl_SummaryMode, FALSE);
  68 EXTERN BOOLEAN              INIT_GLOBAL (Gbl_VerboseMode, FALSE);
  69 EXTERN BOOLEAN              INIT_GLOBAL (Gbl_BinaryMode, FALSE);
  70 EXTERN BOOLEAN              INIT_GLOBAL (Gbl_DumpCustomizedTables, TRUE);
  71 EXTERN BOOLEAN              INIT_GLOBAL (Gbl_DoNotDumpXsdt, FALSE);
  72 EXTERN ACPI_FILE            INIT_GLOBAL (Gbl_OutputFile, NULL);
  73 EXTERN char                 INIT_GLOBAL (*Gbl_OutputFilename, NULL);
  74 EXTERN UINT64               INIT_GLOBAL (Gbl_RsdpBase, 0);
  75
  76 /* Globals required for use with ACPICA modules */
  77
  78 #ifdef _DECLARE_GLOBALS
  79 UINT8                       AcpiGbl_IntegerByteWidth = 8;
  80 #endif
  81
  82 /* Action table used to defer requested options */
  83
  84 typedef struct ap_dump_action
  85 {
  86     char                    *Argument;
  87     UINT32                  ToBeDone;
  88
  89 } AP_DUMP_ACTION;
  90
  91 #define AP_MAX_ACTIONS              32
  92
  93 #define AP_DUMP_ALL_TABLES          0
  94 #define AP_DUMP_TABLE_BY_ADDRESS    1
  95 #define AP_DUMP_TABLE_BY_NAME       2
  96 #define AP_DUMP_TABLE_BY_FILE       3
  97
  98 #define AP_MAX_ACPI_FILES           256 /* Prevent infinite loops */
  99
 100 /* Minimum FADT sizes for various table addresses */
 101
 102 #define MIN_FADT_FOR_DSDT           (ACPI_FADT_OFFSET (Dsdt) + sizeof (UINT32))
 103 #define MIN_FADT_FOR_FACS           (ACPI_FADT_OFFSET (Facs) + sizeof (UINT32))
 104 #define MIN_FADT_FOR_XDSDT          (ACPI_FADT_OFFSET (XDsdt) + sizeof (UINT64))
 105 #define MIN_FADT_FOR_XFACS          (ACPI_FADT_OFFSET (XFacs) + sizeof (UINT64))
 106
 107
 108 /*
 109  * apdump - Table get/dump routines
 110  */
 111 int
 112 ApDumpTableFromFile (
 113     char                    *Pathname);
 114
 115 int
 116 ApDumpTableByName (
 117     char                    *Signature);
 118
 119 int
 120 ApDumpTableByAddress (
 121     char                    *AsciiAddress);
 122
 123 int
 124 ApDumpAllTables (
 125     void);
 126
 127 BOOLEAN
 128 ApIsValidHeader (
 129     ACPI_TABLE_HEADER       *Table);
 130
 131 BOOLEAN
 132 ApIsValidChecksum (
 133     ACPI_TABLE_HEADER       *Table);
 134
 135 UINT32
 136 ApGetTableLength (
 137     ACPI_TABLE_HEADER       *Table);
 138
 139
 140 /*
 141  * apfiles - File I/O utilities
 142  */
 143 int
 144 ApOpenOutputFile (
 145     char                    *Pathname);
 146
 147 int
 148 ApWriteToBinaryFile (
 149     ACPI_TABLE_HEADER       *Table,
 150     UINT32                  Instance);
 151
 152 ACPI_TABLE_HEADER *
 153 ApGetTableFromFile (
 154     char                    *Pathname,
 155     UINT32                  *FileSize);