freebsd-nq/sys/contrib/dev/acpica/dbfileio.c
2000-12-08 09:20:40 +00:00

489 lines
15 KiB
C

/*******************************************************************************
*
* Module Name: dbfileio - Debugger file I/O commands. These can't usually
* be used when running the debugger in Ring 0 (Kernel mode)
* $Revision: 34 $
*
******************************************************************************/
/******************************************************************************
*
* 1. Copyright Notice
*
* Some or all of this work - Copyright (c) 1999, Intel Corp. All rights
* reserved.
*
* 2. License
*
* 2.1. This is your license from Intel Corp. under its intellectual property
* rights. You may have additional license terms from the party that provided
* you this software, covering your right to use that party's intellectual
* property rights.
*
* 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
* copy of the source code appearing in this file ("Covered Code") an
* irrevocable, perpetual, worldwide license under Intel's copyrights in the
* base code distributed originally by Intel ("Original Intel Code") to copy,
* make derivatives, distribute, use and display any portion of the Covered
* Code in any form, with the right to sublicense such rights; and
*
* 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
* license (with the right to sublicense), under only those claims of Intel
* patents that are infringed by the Original Intel Code, to make, use, sell,
* offer to sell, and import the Covered Code and derivative works thereof
* solely to the minimum extent necessary to exercise the above copyright
* license, and in no event shall the patent license extend to any additions
* to or modifications of the Original Intel Code. No other license or right
* is granted directly or by implication, estoppel or otherwise;
*
* The above copyright and patent license is granted only if the following
* conditions are met:
*
* 3. Conditions
*
* 3.1. Redistribution of Source with Rights to Further Distribute Source.
* Redistribution of source code of any substantial portion of the Covered
* Code or modification with rights to further distribute source must include
* the above Copyright Notice, the above License, this list of Conditions,
* and the following Disclaimer and Export Compliance provision. In addition,
* Licensee must cause all Covered Code to which Licensee contributes to
* contain a file documenting the changes Licensee made to create that Covered
* Code and the date of any change. Licensee must include in that file the
* documentation of any changes made by any predecessor Licensee. Licensee
* must include a prominent statement that the modification is derived,
* directly or indirectly, from Original Intel Code.
*
* 3.2. Redistribution of Source with no Rights to Further Distribute Source.
* Redistribution of source code of any substantial portion of the Covered
* Code or modification without rights to further distribute source must
* include the following Disclaimer and Export Compliance provision in the
* documentation and/or other materials provided with distribution. In
* addition, Licensee may not authorize further sublicense of source of any
* portion of the Covered Code, and must include terms to the effect that the
* license from Licensee to its licensee is limited to the intellectual
* property embodied in the software Licensee provides to its licensee, and
* not to intellectual property embodied in modifications its licensee may
* make.
*
* 3.3. Redistribution of Executable. Redistribution in executable form of any
* substantial portion of the Covered Code or modification must reproduce the
* above Copyright Notice, and the following Disclaimer and Export Compliance
* provision in the documentation and/or other materials provided with the
* distribution.
*
* 3.4. Intel retains all right, title, and interest in and to the Original
* Intel Code.
*
* 3.5. Neither the name Intel nor any other trademark owned or controlled by
* Intel shall be used in advertising or otherwise to promote the sale, use or
* other dealings in products derived from or relating to the Covered Code
* without prior written authorization from Intel.
*
* 4. Disclaimer and Export Compliance
*
* 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
* HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
* IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
* INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
* UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
* IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
* PARTICULAR PURPOSE.
*
* 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
* OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
* COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
* SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
* CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
* HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
* SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
* LIMITED REMEDY.
*
* 4.3. Licensee shall not export, either directly or indirectly, any of this
* software or system incorporating such software without first obtaining any
* required license or other approval from the U. S. Department of Commerce or
* any other agency or department of the United States Government. In the
* event Licensee exports any such software from the United States or
* re-exports any such software from a foreign destination, Licensee shall
* ensure that the distribution and export/re-export of the software is in
* compliance with all laws, regulations, orders, or other restrictions of the
* U.S. Export Administration Regulations. Licensee agrees that neither it nor
* any of its subsidiaries will export/re-export any technical data, process,
* software, or service, directly or indirectly, to any country for which the
* United States government or any agency thereof requires an export license,
* other governmental approval, or letter of assurance, without first obtaining
* such license, approval or letter.
*
*****************************************************************************/
#include "acpi.h"
#include "acdebug.h"
#include "acnamesp.h"
#include "acparser.h"
#include "acevents.h"
#include "actables.h"
#ifdef ENABLE_DEBUGGER
#define _COMPONENT DEBUGGER
MODULE_NAME ("dbfileio")
ACPI_PARSE_OBJECT *root;
#ifdef ACPI_APPLICATION
#include <stdio.h>
FILE *DebugFile = NULL;
#endif
/*
* NOTE: this is here for lack of a better place. It is used in all
* flavors of the debugger, need LCD file
*/
/*******************************************************************************
*
* FUNCTION: AcpiDbMatchArgument
*
* PARAMETERS: UserArgument - User command line
* Arguments - Array of commands to match against
*
* RETURN: Index into command array or ACPI_TYPE_NOT_FOUND if not found
*
* DESCRIPTION: Search command array for a command match
*
******************************************************************************/
OBJECT_TYPE_INTERNAL
AcpiDbMatchArgument (
NATIVE_CHAR *UserArgument,
ARGUMENT_INFO *Arguments)
{
UINT32 i;
if (!UserArgument || UserArgument[0] == 0)
{
return (ACPI_TYPE_NOT_FOUND);
}
for (i = 0; Arguments[i].Name; i++)
{
if (STRSTR (Arguments[i].Name, UserArgument) == Arguments[i].Name)
{
return ((OBJECT_TYPE_INTERNAL) i);
}
}
/* Argument not recognized */
return (ACPI_TYPE_NOT_FOUND);
}
/*******************************************************************************
*
* FUNCTION: AcpiDbCloseDebugFile
*
* PARAMETERS: None
*
* RETURN: Status
*
* DESCRIPTION: If open, close the current debug output file
*
******************************************************************************/
void
AcpiDbCloseDebugFile (
void)
{
#ifdef ACPI_APPLICATION
if (DebugFile)
{
fclose (DebugFile);
DebugFile = NULL;
OutputToFile = FALSE;
AcpiOsPrintf ("Debug output file %s closed\n", DebugFilename);
}
#endif
}
/*******************************************************************************
*
* FUNCTION: AcpiDbOpenDebugFile
*
* PARAMETERS: Name - Filename to open
*
* RETURN: Status
*
* DESCRIPTION: Open a file where debug output will be directed.
*
******************************************************************************/
void
AcpiDbOpenDebugFile (
NATIVE_CHAR *Name)
{
#ifdef ACPI_APPLICATION
AcpiDbCloseDebugFile ();
DebugFile = fopen (Name, "w+");
if (DebugFile)
{
AcpiOsPrintf ("Debug output file %s opened\n", Name);
STRCPY (DebugFilename, Name);
OutputToFile = TRUE;
}
#endif
}
#ifdef ACPI_APPLICATION
/*******************************************************************************
*
* FUNCTION: AcpiDbLoadTable
*
* PARAMETERS: fp - File that contains table
* TablePtr - Return value, buffer with table
* TableLenght - Return value, length of table
*
* RETURN: Status
*
* DESCRIPTION: Load the DSDT from the file pointer
*
******************************************************************************/
ACPI_STATUS
AcpiDbLoadTable(
FILE *fp,
ACPI_TABLE_HEADER **TablePtr,
UINT32 *TableLength)
{
ACPI_TABLE_HEADER TableHeader;
UINT8 *AmlPtr;
UINT32 AmlLength;
UINT32 Actual;
ACPI_STATUS Status;
/* Read the table header */
if (fread (&TableHeader, 1, sizeof (TableHeader), fp) != sizeof (ACPI_TABLE_HEADER))
{
AcpiOsPrintf ("Couldn't read the table header\n");
return (AE_BAD_SIGNATURE);
}
/* Validate the table header/length */
Status = AcpiTbValidateTableHeader (&TableHeader);
if ((ACPI_FAILURE (Status)) ||
(TableHeader.Length > (1024 * 1024)))
{
AcpiOsPrintf ("Table header is invalid!\n");
return (AE_ERROR);
}
/* We only support a limited number of table types */
if (STRNCMP ((char *) TableHeader.Signature, DSDT_SIG, 4) &&
STRNCMP ((char *) TableHeader.Signature, PSDT_SIG, 4) &&
STRNCMP ((char *) TableHeader.Signature, SSDT_SIG, 4))
{
AcpiOsPrintf ("Table signature is invalid\n");
DUMP_BUFFER (&TableHeader, sizeof (ACPI_TABLE_HEADER));
return (AE_ERROR);
}
/* Allocate a buffer for the table */
*TableLength = TableHeader.Length;
*TablePtr = (ACPI_TABLE_HEADER *) AcpiCmAllocate ((size_t) *TableLength);
if (!*TablePtr)
{
AcpiOsPrintf ("Could not allocate memory for the table (size=%X)\n", TableHeader.Length);
return (AE_NO_MEMORY);
}
AmlPtr = (UINT8 *) *TablePtr + sizeof (TableHeader);
AmlLength = *TableLength - sizeof (TableHeader);
/* Copy the header to the buffer */
MEMCPY (*TablePtr, &TableHeader, sizeof (TableHeader));
/* Get the rest of the table */
Actual = fread (AmlPtr, 1, (size_t) AmlLength, fp);
if (Actual == AmlLength)
{
return (AE_OK);
}
if (Actual > 0)
{
AcpiOsPrintf ("Warning - reading table, asked for %X got %X\n", AmlLength, Actual);
return (AE_OK);
}
AcpiOsPrintf ("Error - could not read the table file\n");
AcpiCmFree (*TablePtr);
*TablePtr = NULL;
*TableLength = 0;
return (AE_ERROR);
}
#endif
/*******************************************************************************
*
* FUNCTION: AeLocalLoadTable
*
* PARAMETERS: TablePtr - pointer to a buffer containing the entire
* table to be loaded
*
* RETURN: Status
*
* DESCRIPTION: This function is called to load a table from the caller's
* buffer. The buffer must contain an entire ACPI Table including
* a valid header. The header fields will be verified, and if it
* is determined that the table is invalid, the call will fail.
*
* If the call fails an appropriate status will be returned.
*
******************************************************************************/
ACPI_STATUS
AeLocalLoadTable (
ACPI_TABLE_HEADER *TablePtr)
{
ACPI_STATUS Status;
ACPI_TABLE_DESC TableInfo;
FUNCTION_TRACE ("AeLocalLoadTable");
if (!TablePtr)
{
return_ACPI_STATUS (AE_BAD_PARAMETER);
}
/* Install the new table into the local data structures */
TableInfo.Pointer = TablePtr;
Status = AcpiTbInstallTable (NULL, &TableInfo);
if (ACPI_FAILURE (Status))
{
/* Free table allocated by AcpiTbGetTable */
AcpiTbDeleteSingleTable (&TableInfo);
return_ACPI_STATUS (Status);
}
#ifndef PARSER_ONLY
Status = AcpiNsLoadTable (TableInfo.InstalledDesc, AcpiGbl_RootNode);
if (ACPI_FAILURE (Status))
{
/* Uninstall table and free the buffer */
AcpiTbUninstallTable (TableInfo.InstalledDesc);
return_ACPI_STATUS (Status);
}
#endif
return_ACPI_STATUS (Status);
}
/*******************************************************************************
*
* FUNCTION: AcpiDbLoadAcpiTable
*
* PARAMETERS: Filname - File where table is located
*
* RETURN: Status
*
* DESCRIPTION: Load an ACPI table from a file
*
******************************************************************************/
ACPI_STATUS
AcpiDbLoadAcpiTable (
NATIVE_CHAR *Filename)
{
#ifdef ACPI_APPLICATION
FILE *fp;
ACPI_STATUS Status;
ACPI_TABLE_HEADER *TablePtr;
UINT32 TableLength;
/* Open the file */
fp = fopen (Filename, "rb");
if (!fp)
{
AcpiOsPrintf ("Could not open file %s\n", Filename);
return (AE_ERROR);
}
/* Get the entire file */
AcpiOsPrintf ("Loading Acpi table from file %s\n", Filename);
Status = AcpiDbLoadTable (fp, &TablePtr, &TableLength);
fclose(fp);
if (ACPI_FAILURE (Status))
{
AcpiOsPrintf ("Couldn't get table from the file\n");
return (Status);
}
/* Attempt to recognize and install the table */
Status = AeLocalLoadTable (TablePtr);
if (ACPI_FAILURE (Status))
{
if (Status == AE_EXIST)
{
AcpiOsPrintf ("Table %4.4s is already installed\n",
&TablePtr->Signature);
}
else
{
AcpiOsPrintf ("Could not install table, %s\n",
AcpiCmFormatException (Status));
}
AcpiCmFree (TablePtr);
return (Status);
}
AcpiOsPrintf ("%4.4s at %p successfully installed and loaded\n",
&TablePtr->Signature, TablePtr);
AcpiGbl_AcpiHardwarePresent = FALSE;
#endif /* ACPI_APPLICATION */
return (AE_OK);
}
#endif /* ENABLE_DEBUGGER */