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