123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644 |
- /******************************************************************************
- *
- * Module Name: exstore - AML Interpreter object store support
- *
- *****************************************************************************/
- /*
- * Copyright (C) 2000 - 2019, Intel Corp.
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions
- * are met:
- * 1. Redistributions of source code must retain the above copyright
- * notice, this list of conditions, and the following disclaimer,
- * without modification.
- * 2. Redistributions in binary form must reproduce at minimum a disclaimer
- * substantially similar to the "NO WARRANTY" disclaimer below
- * ("Disclaimer") and any redistribution must be conditioned upon
- * including a substantially similar Disclaimer requirement for further
- * binary redistribution.
- * 3. Neither the names of the above-listed copyright holders nor the names
- * of any contributors may be used to endorse or promote products derived
- * from this software without specific prior written permission.
- *
- * Alternatively, this software may be distributed under the terms of the
- * GNU General Public License ("GPL") version 2 as published by the Free
- * Software Foundation.
- *
- * NO WARRANTY
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
- * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
- * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
- * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
- * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
- * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
- * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
- * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
- * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
- * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
- * POSSIBILITY OF SUCH DAMAGES.
- */
- #include "acpi.h"
- #include "accommon.h"
- #include "acdispat.h"
- #include "acinterp.h"
- #include "amlcode.h"
- #include "acnamesp.h"
- #define _COMPONENT ACPI_EXECUTER
- ACPI_MODULE_NAME ("exstore")
- /* Local prototypes */
- static ACPI_STATUS
- AcpiExStoreObjectToIndex (
- ACPI_OPERAND_OBJECT *ValDesc,
- ACPI_OPERAND_OBJECT *DestDesc,
- ACPI_WALK_STATE *WalkState);
- static ACPI_STATUS
- AcpiExStoreDirectToNode (
- ACPI_OPERAND_OBJECT *SourceDesc,
- ACPI_NAMESPACE_NODE *Node,
- ACPI_WALK_STATE *WalkState);
- /*******************************************************************************
- *
- * FUNCTION: AcpiExStore
- *
- * PARAMETERS: *SourceDesc - Value to be stored
- * *DestDesc - Where to store it. Must be an NS node
- * or ACPI_OPERAND_OBJECT of type
- * Reference;
- * WalkState - Current walk state
- *
- * RETURN: Status
- *
- * DESCRIPTION: Store the value described by SourceDesc into the location
- * described by DestDesc. Called by various interpreter
- * functions to store the result of an operation into
- * the destination operand -- not just simply the actual "Store"
- * ASL operator.
- *
- ******************************************************************************/
- ACPI_STATUS
- AcpiExStore (
- ACPI_OPERAND_OBJECT *SourceDesc,
- ACPI_OPERAND_OBJECT *DestDesc,
- ACPI_WALK_STATE *WalkState)
- {
- ACPI_STATUS Status = AE_OK;
- ACPI_OPERAND_OBJECT *RefDesc = DestDesc;
- ACPI_FUNCTION_TRACE_PTR (ExStore, DestDesc);
- /* Validate parameters */
- if (!SourceDesc || !DestDesc)
- {
- ACPI_ERROR ((AE_INFO, "Null parameter"));
- return_ACPI_STATUS (AE_AML_NO_OPERAND);
- }
- /* DestDesc can be either a namespace node or an ACPI object */
- if (ACPI_GET_DESCRIPTOR_TYPE (DestDesc) == ACPI_DESC_TYPE_NAMED)
- {
- /*
- * Dest is a namespace node,
- * Storing an object into a Named node.
- */
- Status = AcpiExStoreObjectToNode (SourceDesc,
- (ACPI_NAMESPACE_NODE *) DestDesc, WalkState,
- ACPI_IMPLICIT_CONVERSION);
- return_ACPI_STATUS (Status);
- }
- /* Destination object must be a Reference or a Constant object */
- switch (DestDesc->Common.Type)
- {
- case ACPI_TYPE_LOCAL_REFERENCE:
- break;
- case ACPI_TYPE_INTEGER:
- /* Allow stores to Constants -- a Noop as per ACPI spec */
- if (DestDesc->Common.Flags & AOPOBJ_AML_CONSTANT)
- {
- return_ACPI_STATUS (AE_OK);
- }
- /*lint -fallthrough */
- default:
- /* Destination is not a Reference object */
- ACPI_ERROR ((AE_INFO,
- "Target is not a Reference or Constant object - [%s] %p",
- AcpiUtGetObjectTypeName (DestDesc), DestDesc));
- return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
- }
- /*
- * Examine the Reference class. These cases are handled:
- *
- * 1) Store to Name (Change the object associated with a name)
- * 2) Store to an indexed area of a Buffer or Package
- * 3) Store to a Method Local or Arg
- * 4) Store to the debug object
- */
- switch (RefDesc->Reference.Class)
- {
- case ACPI_REFCLASS_REFOF:
- /* Storing an object into a Name "container" */
- Status = AcpiExStoreObjectToNode (SourceDesc,
- RefDesc->Reference.Object,
- WalkState, ACPI_IMPLICIT_CONVERSION);
- break;
- case ACPI_REFCLASS_INDEX:
- /* Storing to an Index (pointer into a packager or buffer) */
- Status = AcpiExStoreObjectToIndex (SourceDesc, RefDesc, WalkState);
- break;
- case ACPI_REFCLASS_LOCAL:
- case ACPI_REFCLASS_ARG:
- /* Store to a method local/arg */
- Status = AcpiDsStoreObjectToLocal (RefDesc->Reference.Class,
- RefDesc->Reference.Value, SourceDesc, WalkState);
- break;
- case ACPI_REFCLASS_DEBUG:
- /*
- * Storing to the Debug object causes the value stored to be
- * displayed and otherwise has no effect -- see ACPI Specification
- */
- ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
- "**** Write to Debug Object: Object %p [%s] ****:\n\n",
- SourceDesc, AcpiUtGetObjectTypeName (SourceDesc)));
- ACPI_DEBUG_OBJECT (SourceDesc, 0, 0);
- break;
- default:
- ACPI_ERROR ((AE_INFO, "Unknown Reference Class 0x%2.2X",
- RefDesc->Reference.Class));
- ACPI_DUMP_ENTRY (RefDesc, ACPI_LV_INFO);
- Status = AE_AML_INTERNAL;
- break;
- }
- return_ACPI_STATUS (Status);
- }
- /*******************************************************************************
- *
- * FUNCTION: AcpiExStoreObjectToIndex
- *
- * PARAMETERS: *SourceDesc - Value to be stored
- * *DestDesc - Named object to receive the value
- * WalkState - Current walk state
- *
- * RETURN: Status
- *
- * DESCRIPTION: Store the object to indexed Buffer or Package element
- *
- ******************************************************************************/
- static ACPI_STATUS
- AcpiExStoreObjectToIndex (
- ACPI_OPERAND_OBJECT *SourceDesc,
- ACPI_OPERAND_OBJECT *IndexDesc,
- ACPI_WALK_STATE *WalkState)
- {
- ACPI_STATUS Status = AE_OK;
- ACPI_OPERAND_OBJECT *ObjDesc;
- ACPI_OPERAND_OBJECT *NewDesc;
- UINT8 Value = 0;
- UINT32 i;
- ACPI_FUNCTION_TRACE (ExStoreObjectToIndex);
- /*
- * Destination must be a reference pointer, and
- * must point to either a buffer or a package
- */
- switch (IndexDesc->Reference.TargetType)
- {
- case ACPI_TYPE_PACKAGE:
- /*
- * Storing to a package element. Copy the object and replace
- * any existing object with the new object. No implicit
- * conversion is performed.
- *
- * The object at *(IndexDesc->Reference.Where) is the
- * element within the package that is to be modified.
- * The parent package object is at IndexDesc->Reference.Object
- */
- ObjDesc = *(IndexDesc->Reference.Where);
- if (SourceDesc->Common.Type == ACPI_TYPE_LOCAL_REFERENCE &&
- SourceDesc->Reference.Class == ACPI_REFCLASS_TABLE)
- {
- /* This is a DDBHandle, just add a reference to it */
- AcpiUtAddReference (SourceDesc);
- NewDesc = SourceDesc;
- }
- else
- {
- /* Normal object, copy it */
- Status = AcpiUtCopyIobjectToIobject (
- SourceDesc, &NewDesc, WalkState);
- if (ACPI_FAILURE (Status))
- {
- return_ACPI_STATUS (Status);
- }
- }
- if (ObjDesc)
- {
- /* Decrement reference count by the ref count of the parent package */
- for (i = 0;
- i < ((ACPI_OPERAND_OBJECT *)
- IndexDesc->Reference.Object)->Common.ReferenceCount;
- i++)
- {
- AcpiUtRemoveReference (ObjDesc);
- }
- }
- *(IndexDesc->Reference.Where) = NewDesc;
- /* Increment ref count by the ref count of the parent package-1 */
- for (i = 1;
- i < ((ACPI_OPERAND_OBJECT *)
- IndexDesc->Reference.Object)->Common.ReferenceCount;
- i++)
- {
- AcpiUtAddReference (NewDesc);
- }
- break;
- case ACPI_TYPE_BUFFER_FIELD:
- /*
- * Store into a Buffer or String (not actually a real BufferField)
- * at a location defined by an Index.
- *
- * The first 8-bit element of the source object is written to the
- * 8-bit Buffer location defined by the Index destination object,
- * according to the ACPI 2.0 specification.
- */
- /*
- * Make sure the target is a Buffer or String. An error should
- * not happen here, since the ReferenceObject was constructed
- * by the INDEX_OP code.
- */
- ObjDesc = IndexDesc->Reference.Object;
- if ((ObjDesc->Common.Type != ACPI_TYPE_BUFFER) &&
- (ObjDesc->Common.Type != ACPI_TYPE_STRING))
- {
- return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
- }
- /*
- * The assignment of the individual elements will be slightly
- * different for each source type.
- */
- switch (SourceDesc->Common.Type)
- {
- case ACPI_TYPE_INTEGER:
- /* Use the least-significant byte of the integer */
- Value = (UINT8) (SourceDesc->Integer.Value);
- break;
- case ACPI_TYPE_BUFFER:
- case ACPI_TYPE_STRING:
- /* Note: Takes advantage of common string/buffer fields */
- Value = SourceDesc->Buffer.Pointer[0];
- break;
- default:
- /* All other types are invalid */
- ACPI_ERROR ((AE_INFO,
- "Source must be type [Integer/Buffer/String], found [%s]",
- AcpiUtGetObjectTypeName (SourceDesc)));
- return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
- }
- /* Store the source value into the target buffer byte */
- ObjDesc->Buffer.Pointer[IndexDesc->Reference.Value] = Value;
- break;
- default:
- ACPI_ERROR ((AE_INFO,
- "Target is not of type [Package/BufferField]"));
- Status = AE_AML_TARGET_TYPE;
- break;
- }
- return_ACPI_STATUS (Status);
- }
- /*******************************************************************************
- *
- * FUNCTION: AcpiExStoreObjectToNode
- *
- * PARAMETERS: SourceDesc - Value to be stored
- * Node - Named object to receive the value
- * WalkState - Current walk state
- * ImplicitConversion - Perform implicit conversion (yes/no)
- *
- * RETURN: Status
- *
- * DESCRIPTION: Store the object to the named object.
- *
- * The assignment of an object to a named object is handled here.
- * The value passed in will replace the current value (if any)
- * with the input value.
- *
- * When storing into an object the data is converted to the
- * target object type then stored in the object. This means
- * that the target object type (for an initialized target) will
- * not be changed by a store operation. A CopyObject can change
- * the target type, however.
- *
- * The ImplicitConversion flag is set to NO/FALSE only when
- * storing to an ArgX -- as per the rules of the ACPI spec.
- *
- * Assumes parameters are already validated.
- *
- ******************************************************************************/
- ACPI_STATUS
- AcpiExStoreObjectToNode (
- ACPI_OPERAND_OBJECT *SourceDesc,
- ACPI_NAMESPACE_NODE *Node,
- ACPI_WALK_STATE *WalkState,
- UINT8 ImplicitConversion)
- {
- ACPI_STATUS Status = AE_OK;
- ACPI_OPERAND_OBJECT *TargetDesc;
- ACPI_OPERAND_OBJECT *NewDesc;
- ACPI_OBJECT_TYPE TargetType;
- ACPI_FUNCTION_TRACE_PTR (ExStoreObjectToNode, SourceDesc);
- /* Get current type of the node, and object attached to Node */
- TargetType = AcpiNsGetType (Node);
- TargetDesc = AcpiNsGetAttachedObject (Node);
- ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "Storing %p [%s] to node %p [%s]\n",
- SourceDesc, AcpiUtGetObjectTypeName (SourceDesc),
- Node, AcpiUtGetTypeName (TargetType)));
- /* Only limited target types possible for everything except CopyObject */
- if (WalkState->Opcode != AML_COPY_OBJECT_OP)
- {
- /*
- * Only CopyObject allows all object types to be overwritten. For
- * TargetRef(s), there are restrictions on the object types that
- * are allowed.
- *
- * Allowable operations/typing for Store:
- *
- * 1) Simple Store
- * Integer --> Integer (Named/Local/Arg)
- * String --> String (Named/Local/Arg)
- * Buffer --> Buffer (Named/Local/Arg)
- * Package --> Package (Named/Local/Arg)
- *
- * 2) Store with implicit conversion
- * Integer --> String or Buffer (Named)
- * String --> Integer or Buffer (Named)
- * Buffer --> Integer or String (Named)
- */
- switch (TargetType)
- {
- case ACPI_TYPE_PACKAGE:
- /*
- * Here, can only store a package to an existing package.
- * Storing a package to a Local/Arg is OK, and handled
- * elsewhere.
- */
- if (WalkState->Opcode == AML_STORE_OP)
- {
- if (SourceDesc->Common.Type != ACPI_TYPE_PACKAGE)
- {
- ACPI_ERROR ((AE_INFO,
- "Cannot assign type [%s] to [Package] "
- "(source must be type Pkg)",
- AcpiUtGetObjectTypeName (SourceDesc)));
- return_ACPI_STATUS (AE_AML_TARGET_TYPE);
- }
- break;
- }
- /* Fallthrough */
- case ACPI_TYPE_DEVICE:
- case ACPI_TYPE_EVENT:
- case ACPI_TYPE_MUTEX:
- case ACPI_TYPE_REGION:
- case ACPI_TYPE_POWER:
- case ACPI_TYPE_PROCESSOR:
- case ACPI_TYPE_THERMAL:
- ACPI_ERROR ((AE_INFO,
- "Target must be [Buffer/Integer/String/Reference]"
- ", found [%s] (%4.4s)",
- AcpiUtGetTypeName (Node->Type), Node->Name.Ascii));
- return_ACPI_STATUS (AE_AML_TARGET_TYPE);
- default:
- break;
- }
- }
- /*
- * Resolve the source object to an actual value
- * (If it is a reference object)
- */
- Status = AcpiExResolveObject (&SourceDesc, TargetType, WalkState);
- if (ACPI_FAILURE (Status))
- {
- return_ACPI_STATUS (Status);
- }
- /* Do the actual store operation */
- switch (TargetType)
- {
- /*
- * The simple data types all support implicit source operand
- * conversion before the store.
- */
- case ACPI_TYPE_INTEGER:
- case ACPI_TYPE_STRING:
- case ACPI_TYPE_BUFFER:
- if ((WalkState->Opcode == AML_COPY_OBJECT_OP) ||
- !ImplicitConversion)
- {
- /*
- * However, CopyObject and Stores to ArgX do not perform
- * an implicit conversion, as per the ACPI specification.
- * A direct store is performed instead.
- */
- Status = AcpiExStoreDirectToNode (SourceDesc, Node, WalkState);
- break;
- }
- /* Store with implicit source operand conversion support */
- Status = AcpiExStoreObjectToObject (SourceDesc, TargetDesc,
- &NewDesc, WalkState);
- if (ACPI_FAILURE (Status))
- {
- return_ACPI_STATUS (Status);
- }
- if (NewDesc != TargetDesc)
- {
- /*
- * Store the new NewDesc as the new value of the Name, and set
- * the Name's type to that of the value being stored in it.
- * SourceDesc reference count is incremented by AttachObject.
- *
- * Note: This may change the type of the node if an explicit
- * store has been performed such that the node/object type
- * has been changed.
- */
- Status = AcpiNsAttachObject (
- Node, NewDesc, NewDesc->Common.Type);
- ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
- "Store type [%s] into [%s] via Convert/Attach\n",
- AcpiUtGetObjectTypeName (SourceDesc),
- AcpiUtGetObjectTypeName (NewDesc)));
- }
- break;
- case ACPI_TYPE_BUFFER_FIELD:
- case ACPI_TYPE_LOCAL_REGION_FIELD:
- case ACPI_TYPE_LOCAL_BANK_FIELD:
- case ACPI_TYPE_LOCAL_INDEX_FIELD:
- /*
- * For all fields, always write the source data to the target
- * field. Any required implicit source operand conversion is
- * performed in the function below as necessary. Note, field
- * objects must retain their original type permanently.
- */
- Status = AcpiExWriteDataToField (SourceDesc, TargetDesc,
- &WalkState->ResultObj);
- break;
- default:
- /*
- * CopyObject operator: No conversions for all other types.
- * Instead, directly store a copy of the source object.
- *
- * This is the ACPI spec-defined behavior for the CopyObject
- * operator. (Note, for this default case, all normal
- * Store/Target operations exited above with an error).
- */
- Status = AcpiExStoreDirectToNode (SourceDesc, Node, WalkState);
- break;
- }
- return_ACPI_STATUS (Status);
- }
- /*******************************************************************************
- *
- * FUNCTION: AcpiExStoreDirectToNode
- *
- * PARAMETERS: SourceDesc - Value to be stored
- * Node - Named object to receive the value
- * WalkState - Current walk state
- *
- * RETURN: Status
- *
- * DESCRIPTION: "Store" an object directly to a node. This involves a copy
- * and an attach.
- *
- ******************************************************************************/
- static ACPI_STATUS
- AcpiExStoreDirectToNode (
- ACPI_OPERAND_OBJECT *SourceDesc,
- ACPI_NAMESPACE_NODE *Node,
- ACPI_WALK_STATE *WalkState)
- {
- ACPI_STATUS Status;
- ACPI_OPERAND_OBJECT *NewDesc;
- ACPI_FUNCTION_TRACE (ExStoreDirectToNode);
- ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
- "Storing [%s] (%p) directly into node [%s] (%p)"
- " with no implicit conversion\n",
- AcpiUtGetObjectTypeName (SourceDesc), SourceDesc,
- AcpiUtGetTypeName (Node->Type), Node));
- /* Copy the source object to a new object */
- Status = AcpiUtCopyIobjectToIobject (SourceDesc, &NewDesc, WalkState);
- if (ACPI_FAILURE (Status))
- {
- return_ACPI_STATUS (Status);
- }
- /* Attach the new object to the node */
- Status = AcpiNsAttachObject (Node, NewDesc, NewDesc->Common.Type);
- AcpiUtRemoveReference (NewDesc);
- return_ACPI_STATUS (Status);
- }
|