freebsd-skq/sys/contrib/dev/acpica/dmopcode.c
2002-11-27 18:07:48 +00:00

603 lines
17 KiB
C

/*******************************************************************************
*
* Module Name: dmopcode - AML disassembler, specific AML opcodes
* $Revision: 79 $
*
******************************************************************************/
/******************************************************************************
*
* 1. Copyright Notice
*
* Some or all of this work - Copyright (c) 1999 - 2002, 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 "acparser.h"
#include "amlcode.h"
#include "acdisasm.h"
#include "acdebug.h"
#ifdef ACPI_DISASSEMBLER
#define _COMPONENT ACPI_CA_DEBUGGER
ACPI_MODULE_NAME ("dmopcode")
/*******************************************************************************
*
* FUNCTION: AcpiDmMethodFlags
*
* PARAMETERS: Op - Method Object to be examined
*
* RETURN: None
*
* DESCRIPTION: Decode control method flags
*
******************************************************************************/
void
AcpiDmMethodFlags (
ACPI_PARSE_OBJECT *Op)
{
UINT32 Flags;
UINT32 Args;
/* The next Op contains the flags */
Op = AcpiPsGetDepthNext (NULL, Op);
Flags = Op->Common.Value.Integer8;
Args = Flags & 0x07;
/* Mark the Op as completed */
Op->Common.DisasmFlags |= ACPI_PARSEOP_IGNORE;
/* 1) Method argument count */
AcpiOsPrintf (", %d, ", Args);
/* 2) Serialize rule */
if (!(Flags & 0x08))
{
AcpiOsPrintf ("Not");
}
AcpiOsPrintf ("Serialized");
/* 3) SyncLevel */
if (Flags & 0xF0)
{
AcpiOsPrintf (", %d", Flags >> 4);
}
}
/*******************************************************************************
*
* FUNCTION: AcpiDmFieldFlags
*
* PARAMETERS: Op - Field Object to be examined
*
* RETURN: None
*
* DESCRIPTION: Decode Field definition flags
*
******************************************************************************/
void
AcpiDmFieldFlags (
ACPI_PARSE_OBJECT *Op)
{
UINT32 Flags;
/* The next Op contains the flags */
Op = AcpiPsGetDepthNext (NULL, Op);
Flags = Op->Common.Value.Integer8;
/* Mark the Op as completed */
Op->Common.DisasmFlags |= ACPI_PARSEOP_IGNORE;
AcpiOsPrintf ("%s, ", AcpiGbl_AccessTypes [Flags & 0x0F]);
AcpiOsPrintf ("%s, ", AcpiGbl_LockRule [(Flags & 0x10) >> 4]);
AcpiOsPrintf ("%s)", AcpiGbl_UpdateRules [(Flags & 0x60) >> 5]);
}
/*******************************************************************************
*
* FUNCTION: AcpiDmAddressSpace
*
* PARAMETERS: SpaceId - ID to be translated
*
* RETURN: None
*
* DESCRIPTION: Decode a SpaceId to an AddressSpaceKeyword
*
******************************************************************************/
void
AcpiDmAddressSpace (
UINT8 SpaceId)
{
if (SpaceId >= ACPI_NUM_PREDEFINED_REGIONS)
{
if (SpaceId == 0x7F)
{
AcpiOsPrintf ("FFixedHW, ");
}
else
{
AcpiOsPrintf ("0x%.2X, ", SpaceId);
}
}
else
{
AcpiOsPrintf ("%s, ", AcpiGbl_RegionTypes [SpaceId]);
}
}
/*******************************************************************************
*
* FUNCTION: AcpiDmRegionFlags
*
* PARAMETERS: Op - Object to be examined
*
* RETURN: None
*
* DESCRIPTION: Decode OperationRegion flags
*
******************************************************************************/
void
AcpiDmRegionFlags (
ACPI_PARSE_OBJECT *Op)
{
/* The next Op contains the SpaceId */
Op = AcpiPsGetDepthNext (NULL, Op);
/* Mark the Op as completed */
Op->Common.DisasmFlags |= ACPI_PARSEOP_IGNORE;
AcpiOsPrintf (", ");
AcpiDmAddressSpace (Op->Common.Value.Integer8);
}
/*******************************************************************************
*
* FUNCTION: AcpiDmMatchOp
*
* PARAMETERS: Op - Match Object to be examined
*
* RETURN: None
*
* DESCRIPTION: Decode Match opcode operands
*
******************************************************************************/
void
AcpiDmMatchOp (
ACPI_PARSE_OBJECT *Op)
{
ACPI_PARSE_OBJECT *NextOp;
NextOp = AcpiPsGetDepthNext (NULL, Op);
NextOp = NextOp->Common.Next;
if (!NextOp)
{
/* Handle partial tree during single-step */
return;
}
/* Mark the two nodes that contain the encoding for the match keywords */
NextOp->Common.DisasmOpcode = ACPI_DASM_MATCHOP;
NextOp = NextOp->Common.Next;
NextOp = NextOp->Common.Next;
NextOp->Common.DisasmOpcode = ACPI_DASM_MATCHOP;
}
/*******************************************************************************
*
* FUNCTION: AcpiDmMatchKeyword
*
* PARAMETERS: Op - Match Object to be examined
*
* RETURN: None
*
* DESCRIPTION: Decode Match opcode operands
*
******************************************************************************/
void
AcpiDmMatchKeyword (
ACPI_PARSE_OBJECT *Op)
{
if (Op->Common.Value.Integer32 >= NUM_MATCH_OPS)
{
AcpiOsPrintf ("/* Unknown Match Keyword encoding */");
}
else
{
AcpiOsPrintf ("%s", (char *) AcpiGbl_MatchOps[Op->Common.Value.Integer32]);
}
}
/*******************************************************************************
*
* FUNCTION: AcpiDmDisassembleOneOp
*
* PARAMETERS: WalkState - Current walk info
* Info - Parse tree walk info
* Op - Op that is to be printed
*
* RETURN: None
*
* DESCRIPTION: Disassemble a single AML opcode
*
******************************************************************************/
void
AcpiDmDisassembleOneOp (
ACPI_WALK_STATE *WalkState,
ACPI_OP_WALK_INFO *Info,
ACPI_PARSE_OBJECT *Op)
{
const ACPI_OPCODE_INFO *OpInfo = NULL;
UINT32 Offset;
UINT32 Length;
if (!Op)
{
AcpiOsPrintf ("<NULL OP PTR>");
return;
}
switch (Op->Common.DisasmOpcode)
{
case ACPI_DASM_MATCHOP:
AcpiDmMatchKeyword (Op);
return;
default:
break;
}
/* op and arguments */
switch (Op->Common.AmlOpcode)
{
case AML_ZERO_OP:
AcpiOsPrintf ("Zero");
break;
case AML_ONE_OP:
AcpiOsPrintf ("One");
break;
case AML_ONES_OP:
AcpiOsPrintf ("Ones");
break;
case AML_REVISION_OP:
AcpiOsPrintf ("Revision");
break;
case AML_BYTE_OP:
AcpiOsPrintf ("0x%2.2X", (UINT32) Op->Common.Value.Integer8);
break;
case AML_WORD_OP:
if (Op->Common.DisasmOpcode == ACPI_DASM_EISAID)
{
AcpiDmEisaId (Op->Common.Value.Integer32);
}
else
{
AcpiOsPrintf ("0x%4.4X", (UINT32) Op->Common.Value.Integer16);
}
break;
case AML_DWORD_OP:
if (Op->Common.DisasmOpcode == ACPI_DASM_EISAID)
{
AcpiDmEisaId (Op->Common.Value.Integer32);
}
else
{
AcpiOsPrintf ("0x%8.8X", Op->Common.Value.Integer32);
}
break;
case AML_QWORD_OP:
AcpiOsPrintf ("0x%8.8X%8.8X", Op->Common.Value.Integer64.Hi,
Op->Common.Value.Integer64.Lo);
break;
case AML_STRING_OP:
AcpiUtPrintString (Op->Common.Value.String, ACPI_UINT8_MAX);
break;
case AML_BUFFER_OP:
/*
* Determine the type of buffer. We can have one of the following:
*
* 1) ResourceTemplate containing Resource Descriptors.
* 2) Unicode String buffer
* 3) ASCII String buffer
* 4) Raw data buffer (if none of the above)
*
* Since there are no special AML opcodes to differentiate these
* types of buffers, we have to closely look at the data in the
* buffer to determine the type.
*/
if (AcpiDmIsResourceDescriptor (Op))
{
Op->Common.DisasmOpcode = ACPI_DASM_RESOURCE;
AcpiOsPrintf ("ResourceTemplate");
}
else if (AcpiDmIsUnicodeBuffer (Op))
{
Op->Common.DisasmOpcode = ACPI_DASM_UNICODE;
AcpiOsPrintf ("Unicode (");
}
else if (AcpiDmIsStringBuffer (Op))
{
Op->Common.DisasmOpcode = ACPI_DASM_STRING;
AcpiOsPrintf ("Buffer");
}
else
{
Op->Common.DisasmOpcode = ACPI_DASM_BUFFER;
AcpiOsPrintf ("Buffer");
}
break;
case AML_INT_STATICSTRING_OP:
if (Op->Common.Value.String)
{
AcpiOsPrintf ("%s", Op->Common.Value.String);
}
else
{
AcpiOsPrintf ("\"<NULL STATIC STRING PTR>\"");
}
break;
case AML_INT_NAMEPATH_OP:
AcpiDmNamestring (Op->Common.Value.Name);
AcpiDmValidateName (Op->Common.Value.Name, Op);
break;
case AML_INT_NAMEDFIELD_OP:
Length = AcpiDmDumpName ((char *) &Op->Named.Name);
AcpiOsPrintf (",%*.s %d", (int) (5 - Length), " ", Op->Common.Value.Integer32);
AcpiDmCommaIfFieldMember (Op);
Info->BitOffset += Op->Common.Value.Integer32;
break;
case AML_INT_RESERVEDFIELD_OP:
/* Offset() -- Must account for previous offsets */
Offset = Op->Common.Value.Integer32;
Info->BitOffset += Offset;
if (Info->BitOffset % 8 == 0)
{
AcpiOsPrintf ("Offset (0x%.2X)", ACPI_DIV_8 (Info->BitOffset));
}
else
{
AcpiOsPrintf (" , %d", Offset);
}
AcpiDmCommaIfFieldMember (Op);
break;
case AML_INT_ACCESSFIELD_OP:
AcpiOsPrintf ("AccessAs (%s, ",
AcpiGbl_AccessTypes [Op->Common.Value.Integer32 >> 8]);
AcpiDmDecodeAttribute ((UINT8) Op->Common.Value.Integer32);
AcpiOsPrintf (")");
AcpiDmCommaIfFieldMember (Op);
break;
case AML_INT_BYTELIST_OP:
AcpiDmByteList (Info, Op);
break;
case AML_INT_METHODCALL_OP:
OpInfo = AcpiPsGetOpcodeInfo (Op->Common.AmlOpcode);
Op = AcpiPsGetDepthNext (NULL, Op);
Op->Common.DisasmFlags |= ACPI_PARSEOP_IGNORE;
AcpiDmNamestring (Op->Common.Value.Name);
break;
default:
/* Just get the opcode name and print it */
OpInfo = AcpiPsGetOpcodeInfo (Op->Common.AmlOpcode);
AcpiOsPrintf ("%s", OpInfo->Name);
#ifdef ACPI_DEBUGGER
if ((Op->Common.AmlOpcode == AML_INT_RETURN_VALUE_OP) &&
(WalkState) &&
(WalkState->Results) &&
(WalkState->Results->Results.NumResults))
{
AcpiDbDecodeInternalObject (
WalkState->Results->Results.ObjDesc [WalkState->Results->Results.NumResults-1]);
}
#endif
break;
}
}
#endif /* ACPI_DISASSEMBLER */