LXR linux/tools/power/acpi/tools/acpidump/acpidump.h

   1/******************************************************************************
   2 *
   3 * Module Name: acpidump.h - Include file for acpi_dump 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/acpi.h>
  56#include "accommon.h"
  57#include "actables.h"
  58#include "acapps.h"
  59
  60/* Globals */
  61
  62EXTERN u8 INIT_GLOBAL(gbl_summary_mode, FALSE);
  63EXTERN u8 INIT_GLOBAL(gbl_verbose_mode, FALSE);
  64EXTERN u8 INIT_GLOBAL(gbl_binary_mode, FALSE);
  65EXTERN u8 INIT_GLOBAL(gbl_dump_customized_tables, TRUE);
  66EXTERN u8 INIT_GLOBAL(gbl_do_not_dump_xsdt, FALSE);
  67EXTERN ACPI_FILE INIT_GLOBAL(gbl_output_file, NULL);
  68EXTERN char INIT_GLOBAL(*gbl_output_filename, NULL);
  69EXTERN u64 INIT_GLOBAL(gbl_rsdp_base, 0);
  70
  71/* Action table used to defer requested options */
  72
  73struct ap_dump_action {
  74        char *argument;
  75        u32 to_be_done;
  76};
  77
  78#define AP_MAX_ACTIONS              32
  79
  80#define AP_DUMP_ALL_TABLES          0
  81#define AP_DUMP_TABLE_BY_ADDRESS    1
  82#define AP_DUMP_TABLE_BY_NAME       2
  83#define AP_DUMP_TABLE_BY_FILE       3
  84
  85#define AP_MAX_ACPI_FILES           256 /* Prevent infinite loops */
  86
  87/* Minimum FADT sizes for various table addresses */
  88
  89#define MIN_FADT_FOR_DSDT           (ACPI_FADT_OFFSET (dsdt) + sizeof (u32))
  90#define MIN_FADT_FOR_FACS           (ACPI_FADT_OFFSET (facs) + sizeof (u32))
  91#define MIN_FADT_FOR_XDSDT          (ACPI_FADT_OFFSET (Xdsdt) + sizeof (u64))
  92#define MIN_FADT_FOR_XFACS          (ACPI_FADT_OFFSET (Xfacs) + sizeof (u64))
  93
  94/*
  95 * apdump - Table get/dump routines
  96 */
  97int ap_dump_table_from_file(char *pathname);
  98
  99int ap_dump_table_by_name(char *signature);
 100
 101int ap_dump_table_by_address(char *ascii_address);
 102
 103int ap_dump_all_tables(void);
 104
 105u8 ap_is_valid_header(struct acpi_table_header *table);
 106
 107u8 ap_is_valid_checksum(struct acpi_table_header *table);
 108
 109u32 ap_get_table_length(struct acpi_table_header *table);
 110
 111/*
 112 * apfiles - File I/O utilities
 113 */
 114int ap_open_output_file(char *pathname);
 115
 116int ap_write_to_binary_file(struct acpi_table_header *table, u32 instance);
 117
 118struct acpi_table_header *ap_get_table_from_file(char *pathname,
 119                                                 u32 *file_size);
 120