7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek/******************************************************************************
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek *
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * Module Name: acpixtract.h - Include for acpixtract utility
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek *
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek *****************************************************************************/
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek/*
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * Copyright (C) 2000 - 2016, Intel Corp.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * All rights reserved.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek *
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * Redistribution and use in source and binary forms, with or without
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * modification, are permitted provided that the following conditions
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * are met:
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * 1. Redistributions of source code must retain the above copyright
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * notice, this list of conditions, and the following disclaimer,
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * without modification.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * 2. Redistributions in binary form must reproduce at minimum a disclaimer
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * substantially similar to the "NO WARRANTY" disclaimer below
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * ("Disclaimer") and any redistribution must be conditioned upon
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * including a substantially similar Disclaimer requirement for further
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * binary redistribution.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * 3. Neither the names of the above-listed copyright holders nor the names
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * of any contributors may be used to endorse or promote products derived
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * from this software without specific prior written permission.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek *
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * Alternatively, this software may be distributed under the terms of the
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * GNU General Public License ("GPL") version 2 as published by the Free
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * Software Foundation.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek *
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * NO WARRANTY
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * POSSIBILITY OF SUCH DAMAGES.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek */
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek#include "acpi.h"
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek#include "accommon.h"
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek#include "acapps.h"
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek#include <stdio.h>
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek#undef ACPI_GLOBAL
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek#ifdef DEFINE_ACPIXTRACT_GLOBALS
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek#define ACPI_GLOBAL(type,name) \
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek extern type name; \
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek type name
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek#else
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek#define ACPI_GLOBAL(type,name) \
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek extern type name
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek#endif
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek/* Options */
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek#define AX_EXTRACT_ALL 0
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek#define AX_LIST_ALL 1
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek#define AX_EXTRACT_SIGNATURE 2
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek#define AX_EXTRACT_AML_TABLES 3
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek#define AX_EXTRACT_MULTI_TABLE 4
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek#define AX_OPTIONAL_TABLES 0
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek#define AX_REQUIRED_TABLE 1
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek#define AX_UTILITY_NAME "ACPI Binary Table Extraction Utility"
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek#define AX_SUPPORTED_OPTIONS "ahlms:v"
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek#define AX_MULTI_TABLE_FILENAME "amltables.dat"
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek#define AX_TABLE_INFO_FORMAT "Acpi table [%4.4s] - %7u bytes written to %s\n"
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek/* Extraction states */
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek#define AX_STATE_FIND_HEADER 0
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek#define AX_STATE_EXTRACT_DATA 1
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek/* Miscellaneous constants */
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek#define AX_LINE_BUFFER_SIZE 256
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek#define AX_MIN_BLOCK_HEADER_LENGTH 6 /* strlen ("DSDT @") */
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinektypedef struct AxTableInfo
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek{
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek UINT32 Signature;
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek unsigned int Instances;
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek unsigned int NextInstance;
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek struct AxTableInfo *Next;
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek} AX_TABLE_INFO;
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek/* Globals */
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry JelinekACPI_GLOBAL (char, Gbl_LineBuffer[AX_LINE_BUFFER_SIZE]);
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry JelinekACPI_GLOBAL (char, Gbl_HeaderBuffer[AX_LINE_BUFFER_SIZE]);
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry JelinekACPI_GLOBAL (char, Gbl_InstanceBuffer[AX_LINE_BUFFER_SIZE]);
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry JelinekACPI_GLOBAL (AX_TABLE_INFO, *Gbl_TableListHead);
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry JelinekACPI_GLOBAL (char, Gbl_OutputFilename[32]);
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry JelinekACPI_GLOBAL (unsigned char, Gbl_BinaryData[16]);
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry JelinekACPI_GLOBAL (unsigned int, Gbl_TableCount);
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek/*
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * acpixtract.c
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek */
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinekint
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry JelinekAxExtractTables (
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek char *InputPathname,
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek char *Signature,
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek unsigned int MinimumInstances);
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinekint
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry JelinekAxExtractToMultiAmlFile (
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek char *InputPathname);
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinekint
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry JelinekAxListTables (
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek char *InputPathname);
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek/*
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * axutils.c
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek */
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelineksize_t
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry JelinekAxGetTableHeader (
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek FILE *InputFile,
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek unsigned char *OutputData);
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinekunsigned int
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry JelinekAxCountTableInstances (
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek char *InputPathname,
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek char *Signature);
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinekunsigned int
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry JelinekAxGetNextInstance (
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek char *InputPathname,
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek char *Signature);
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinekvoid
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry JelinekAxNormalizeSignature (
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek char *Signature);
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinekvoid
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry JelinekAxCheckAscii (
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek char *Name,
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek int Count);
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinekint
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry JelinekAxIsEmptyLine (
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek char *Buffer);
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinekint
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry JelinekAxIsDataBlockHeader (
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek void);
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelineklong
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry JelinekAxProcessOneTextLine (
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek FILE *OutputFile,
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek char *ThisSignature,
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek unsigned int ThisTableBytesWritten);
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelineksize_t
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry JelinekAxConvertLine (
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek char *InputLine,
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek unsigned char *OutputData);