freebsd-dev/sys/contrib/dev/acpica/dsfield.c
Mike Smith 926328c406 Initial import of the Intel-maintained ACPI Component Architecture. This
is Intel's reference implementation of the core operating-system ACPI
support.  (This import is on the vendor branch.)
2000-10-28 05:01:06 +00:00

547 lines
18 KiB
C

/******************************************************************************
*
* Module Name: dsfield - Dispatcher field routines
* $Revision: 29 $
*
*****************************************************************************/
/******************************************************************************
*
* 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.
*
*****************************************************************************/
#define __DSFIELD_C__
#include "acpi.h"
#include "amlcode.h"
#include "acdispat.h"
#include "acinterp.h"
#include "acnamesp.h"
#define _COMPONENT DISPATCHER
MODULE_NAME ("dsfield")
/*
* Field flags: Bits 00 - 03 : AccessType (AnyAcc, ByteAcc, etc.)
* 04 : LockRule (1 == Lock)
* 05 - 06 : UpdateRule
*/
#define FIELD_ACCESS_TYPE_MASK 0x0F
#define FIELD_LOCK_RULE_MASK 0x10
#define FIELD_UPDATE_RULE_MASK 0x60
/*******************************************************************************
*
* FUNCTION: AcpiDsCreateField
*
* PARAMETERS: Op - Op containing the Field definition and args
* RegionNode - Object for the containing Operation Region
*
* RETURN: Status
*
* DESCRIPTION: Create a new field in the specified operation region
*
******************************************************************************/
ACPI_STATUS
AcpiDsCreateField (
ACPI_PARSE_OBJECT *Op,
ACPI_NAMESPACE_NODE *RegionNode,
ACPI_WALK_STATE *WalkState)
{
ACPI_STATUS Status = AE_AML_ERROR;
ACPI_PARSE_OBJECT *Arg;
ACPI_NAMESPACE_NODE *Node;
UINT8 FieldFlags;
UINT8 AccessAttribute = 0;
UINT32 FieldBitPosition = 0;
FUNCTION_TRACE_PTR ("DsCreateField", Op);
/* First arg is the name of the parent OpRegion */
Arg = Op->Value.Arg;
if (!RegionNode)
{
Status = AcpiNsLookup (WalkState->ScopeInfo, Arg->Value.Name,
ACPI_TYPE_REGION, IMODE_EXECUTE,
NS_SEARCH_PARENT, WalkState,
&RegionNode);
if (ACPI_FAILURE (Status))
{
return_ACPI_STATUS (Status);
}
}
/* Second arg is the field flags */
Arg = Arg->Next;
FieldFlags = (UINT8) Arg->Value.Integer;
/* Each remaining arg is a Named Field */
Arg = Arg->Next;
while (Arg)
{
switch (Arg->Opcode)
{
case AML_RESERVEDFIELD_OP:
FieldBitPosition += Arg->Value.Size;
break;
case AML_ACCESSFIELD_OP:
/*
* Get a new AccessType and AccessAttribute for all
* entries (until end or another AccessAs keyword)
*/
AccessAttribute = (UINT8) Arg->Value.Integer;
FieldFlags = (UINT8)
((FieldFlags & FIELD_ACCESS_TYPE_MASK) ||
((UINT8) (Arg->Value.Integer >> 8)));
break;
case AML_NAMEDFIELD_OP:
Status = AcpiNsLookup (WalkState->ScopeInfo,
(NATIVE_CHAR *) &((ACPI_PARSE2_OBJECT *)Arg)->Name,
INTERNAL_TYPE_DEF_FIELD,
IMODE_LOAD_PASS1,
NS_NO_UPSEARCH | NS_DONT_OPEN_SCOPE,
NULL, &Node);
if (ACPI_FAILURE (Status))
{
return_ACPI_STATUS (Status);
}
/*
* Initialize an object for the new Node that is on
* the object stack
*/
Status = AcpiAmlPrepDefFieldValue (Node, RegionNode, FieldFlags,
AccessAttribute, FieldBitPosition, Arg->Value.Size);
if (ACPI_FAILURE (Status))
{
return_ACPI_STATUS (Status);
}
/* Keep track of bit position for *next* field */
FieldBitPosition += Arg->Value.Size;
break;
}
Arg = Arg->Next;
}
return_ACPI_STATUS (Status);
}
/*******************************************************************************
*
* FUNCTION: AcpiDsCreateBankField
*
* PARAMETERS: Op - Op containing the Field definition and args
* RegionNode - Object for the containing Operation Region
*
* RETURN: Status
*
* DESCRIPTION: Create a new bank field in the specified operation region
*
******************************************************************************/
ACPI_STATUS
AcpiDsCreateBankField (
ACPI_PARSE_OBJECT *Op,
ACPI_NAMESPACE_NODE *RegionNode,
ACPI_WALK_STATE *WalkState)
{
ACPI_STATUS Status = AE_AML_ERROR;
ACPI_PARSE_OBJECT *Arg;
ACPI_NAMESPACE_NODE *RegisterNode;
ACPI_NAMESPACE_NODE *Node;
UINT32 BankValue;
UINT8 FieldFlags;
UINT8 AccessAttribute = 0;
UINT32 FieldBitPosition = 0;
FUNCTION_TRACE_PTR ("DsCreateBankField", Op);
/* First arg is the name of the parent OpRegion */
Arg = Op->Value.Arg;
if (!RegionNode)
{
Status = AcpiNsLookup (WalkState->ScopeInfo, Arg->Value.Name,
ACPI_TYPE_REGION, IMODE_EXECUTE,
NS_SEARCH_PARENT, WalkState,
&RegionNode);
if (ACPI_FAILURE (Status))
{
return_ACPI_STATUS (Status);
}
}
/* Second arg is the Bank Register */
Arg = Arg->Next;
Status = AcpiNsLookup (WalkState->ScopeInfo, Arg->Value.String,
INTERNAL_TYPE_BANK_FIELD_DEFN,
IMODE_LOAD_PASS1,
NS_NO_UPSEARCH | NS_DONT_OPEN_SCOPE,
NULL, &RegisterNode);
if (ACPI_FAILURE (Status))
{
return_ACPI_STATUS (Status);
}
/* Third arg is the BankValue */
Arg = Arg->Next;
BankValue = Arg->Value.Integer;
/* Next arg is the field flags */
Arg = Arg->Next;
FieldFlags = (UINT8) Arg->Value.Integer;
/* Each remaining arg is a Named Field */
Arg = Arg->Next;
while (Arg)
{
switch (Arg->Opcode)
{
case AML_RESERVEDFIELD_OP:
FieldBitPosition += Arg->Value.Size;
break;
case AML_ACCESSFIELD_OP:
/*
* Get a new AccessType and AccessAttribute for
* all entries (until end or another AccessAs keyword)
*/
AccessAttribute = (UINT8) Arg->Value.Integer;
FieldFlags = (UINT8)
((FieldFlags & FIELD_ACCESS_TYPE_MASK) ||
((UINT8) (Arg->Value.Integer >> 8)));
break;
case AML_NAMEDFIELD_OP:
Status = AcpiNsLookup (WalkState->ScopeInfo,
(NATIVE_CHAR *) &((ACPI_PARSE2_OBJECT *)Arg)->Name,
INTERNAL_TYPE_DEF_FIELD,
IMODE_LOAD_PASS1,
NS_NO_UPSEARCH | NS_DONT_OPEN_SCOPE,
NULL, &Node);
if (ACPI_FAILURE (Status))
{
return_ACPI_STATUS (Status);
}
/*
* Initialize an object for the new Node that is on
* the object stack
*/
Status = AcpiAmlPrepBankFieldValue (Node, RegionNode, RegisterNode,
BankValue, FieldFlags, AccessAttribute,
FieldBitPosition, Arg->Value.Size);
if (ACPI_FAILURE (Status))
{
return_ACPI_STATUS (Status);
}
/* Keep track of bit position for the *next* field */
FieldBitPosition += Arg->Value.Size;
break;
}
Arg = Arg->Next;
}
return_ACPI_STATUS (Status);
}
/*******************************************************************************
*
* FUNCTION: AcpiDsCreateIndexField
*
* PARAMETERS: Op - Op containing the Field definition and args
* RegionNode - Object for the containing Operation Region
*
* RETURN: Status
*
* DESCRIPTION: Create a new index field in the specified operation region
*
******************************************************************************/
ACPI_STATUS
AcpiDsCreateIndexField (
ACPI_PARSE_OBJECT *Op,
ACPI_HANDLE RegionNode,
ACPI_WALK_STATE *WalkState)
{
ACPI_STATUS Status;
ACPI_PARSE_OBJECT *Arg;
ACPI_NAMESPACE_NODE *Node;
ACPI_NAMESPACE_NODE *IndexRegisterNode;
ACPI_NAMESPACE_NODE *DataRegisterNode;
UINT8 FieldFlags;
UINT8 AccessAttribute = 0;
UINT32 FieldBitPosition = 0;
FUNCTION_TRACE_PTR ("DsCreateIndexField", Op);
Arg = Op->Value.Arg;
/* First arg is the name of the Index register */
Status = AcpiNsLookup (WalkState->ScopeInfo, Arg->Value.String,
ACPI_TYPE_ANY, IMODE_LOAD_PASS1,
NS_NO_UPSEARCH | NS_DONT_OPEN_SCOPE,
NULL, &IndexRegisterNode);
if (ACPI_FAILURE (Status))
{
return_ACPI_STATUS (Status);
}
/* Second arg is the data register */
Arg = Arg->Next;
Status = AcpiNsLookup (WalkState->ScopeInfo, Arg->Value.String,
INTERNAL_TYPE_INDEX_FIELD_DEFN,
IMODE_LOAD_PASS1,
NS_NO_UPSEARCH | NS_DONT_OPEN_SCOPE,
NULL, &DataRegisterNode);
if (ACPI_FAILURE (Status))
{
return_ACPI_STATUS (Status);
}
/* Next arg is the field flags */
Arg = Arg->Next;
FieldFlags = (UINT8) Arg->Value.Integer;
/* Each remaining arg is a Named Field */
Arg = Arg->Next;
while (Arg)
{
switch (Arg->Opcode)
{
case AML_RESERVEDFIELD_OP:
FieldBitPosition += Arg->Value.Size;
break;
case AML_ACCESSFIELD_OP:
/*
* Get a new AccessType and AccessAttribute for all
* entries (until end or another AccessAs keyword)
*/
AccessAttribute = (UINT8) Arg->Value.Integer;
FieldFlags = (UINT8)
((FieldFlags & FIELD_ACCESS_TYPE_MASK) ||
((UINT8) (Arg->Value.Integer >> 8)));
break;
case AML_NAMEDFIELD_OP:
Status = AcpiNsLookup (WalkState->ScopeInfo,
(NATIVE_CHAR *) &((ACPI_PARSE2_OBJECT *)Arg)->Name,
INTERNAL_TYPE_INDEX_FIELD,
IMODE_LOAD_PASS1,
NS_NO_UPSEARCH | NS_DONT_OPEN_SCOPE,
NULL, &Node);
if (ACPI_FAILURE (Status))
{
return_ACPI_STATUS (Status);
}
/*
* Initialize an object for the new Node that is on
* the object stack
*/
Status = AcpiAmlPrepIndexFieldValue (Node, IndexRegisterNode, DataRegisterNode,
FieldFlags, AccessAttribute,
FieldBitPosition, Arg->Value.Size);
if (ACPI_FAILURE (Status))
{
return_ACPI_STATUS (Status);
}
/* Keep track of bit position for the *next* field */
FieldBitPosition += Arg->Value.Size;
break;
default:
DEBUG_PRINT (ACPI_ERROR,
("DsEnterIndexField: Invalid opcode in field list: %X\n",
Arg->Opcode));
Status = AE_AML_ERROR;
break;
}
Arg = Arg->Next;
}
return_ACPI_STATUS (Status);
}