sys/contrib/dev/acpica/exstoren.c

   1
   2 /******************************************************************************
   3  *
   4  * Module Name: exstoren - AML Interpreter object store support,
   5  *                        Store to Node (namespace object)
   6  *              $Revision: 46 $
   7  *
   8  *****************************************************************************/
   9
  10 /******************************************************************************
  11  *
  12  * 1. Copyright Notice
  13  *
  14  * Some or all of this work - Copyright (c) 1999 - 2002, Intel Corp.
  15  * All rights reserved.
  16  *
  17  * 2. License
  18  *
  19  * 2.1. This is your license from Intel Corp. under its intellectual property
  20  * rights.  You may have additional license terms from the party that provided
  21  * you this software, covering your right to use that party's intellectual
  22  * property rights.
  23  *
  24  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
  25  * copy of the source code appearing in this file ("Covered Code") an
  26  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
  27  * base code distributed originally by Intel ("Original Intel Code") to copy,
  28  * make derivatives, distribute, use and display any portion of the Covered
  29  * Code in any form, with the right to sublicense such rights; and
  30  *
  31  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
  32  * license (with the right to sublicense), under only those claims of Intel
  33  * patents that are infringed by the Original Intel Code, to make, use, sell,
  34  * offer to sell, and import the Covered Code and derivative works thereof
  35  * solely to the minimum extent necessary to exercise the above copyright
  36  * license, and in no event shall the patent license extend to any additions
  37  * to or modifications of the Original Intel Code.  No other license or right
  38  * is granted directly or by implication, estoppel or otherwise;
  39  *
  40  * The above copyright and patent license is granted only if the following
  41  * conditions are met:
  42  *
  43  * 3. Conditions
  44  *
  45  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
  46  * Redistribution of source code of any substantial portion of the Covered
  47  * Code or modification with rights to further distribute source must include
  48  * the above Copyright Notice, the above License, this list of Conditions,
  49  * and the following Disclaimer and Export Compliance provision.  In addition,
  50  * Licensee must cause all Covered Code to which Licensee contributes to
  51  * contain a file documenting the changes Licensee made to create that Covered
  52  * Code and the date of any change.  Licensee must include in that file the
  53  * documentation of any changes made by any predecessor Licensee.  Licensee
  54  * must include a prominent statement that the modification is derived,
  55  * directly or indirectly, from Original Intel Code.
  56  *
  57  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
  58  * Redistribution of source code of any substantial portion of the Covered
  59  * Code or modification without rights to further distribute source must
  60  * include the following Disclaimer and Export Compliance provision in the
  61  * documentation and/or other materials provided with distribution.  In
  62  * addition, Licensee may not authorize further sublicense of source of any
  63  * portion of the Covered Code, and must include terms to the effect that the
  64  * license from Licensee to its licensee is limited to the intellectual
  65  * property embodied in the software Licensee provides to its licensee, and
  66  * not to intellectual property embodied in modifications its licensee may
  67  * make.
  68  *
  69  * 3.3. Redistribution of Executable. Redistribution in executable form of any
  70  * substantial portion of the Covered Code or modification must reproduce the
  71  * above Copyright Notice, and the following Disclaimer and Export Compliance
  72  * provision in the documentation and/or other materials provided with the
  73  * distribution.
  74  *
  75  * 3.4. Intel retains all right, title, and interest in and to the Original
  76  * Intel Code.
  77  *
  78  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
  79  * Intel shall be used in advertising or otherwise to promote the sale, use or
  80  * other dealings in products derived from or relating to the Covered Code
  81  * without prior written authorization from Intel.
  82  *
  83  * 4. Disclaimer and Export Compliance
  84  *
  85  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
  86  * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
  87  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
  88  * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
  89  * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
  90  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
  91  * PARTICULAR PURPOSE.
  92  *
  93  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
  94  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
  95  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
  96  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
  97  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
  98  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
  99  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
 100  * LIMITED REMEDY.
 101  *
 102  * 4.3. Licensee shall not export, either directly or indirectly, any of this
 103  * software or system incorporating such software without first obtaining any
 104  * required license or other approval from the U. S. Department of Commerce or
 105  * any other agency or department of the United States Government.  In the
 106  * event Licensee exports any such software from the United States or
 107  * re-exports any such software from a foreign destination, Licensee shall
 108  * ensure that the distribution and export/re-export of the software is in
 109  * compliance with all laws, regulations, orders, or other restrictions of the
 110  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
 111  * any of its subsidiaries will export/re-export any technical data, process,
 112  * software, or service, directly or indirectly, to any country for which the
 113  * United States government or any agency thereof requires an export license,
 114  * other governmental approval, or letter of assurance, without first obtaining
 115  * such license, approval or letter.
 116  *
 117  *****************************************************************************/
 118
 119 #define __EXSTOREN_C__
 120
 121 #include "acpi.h"
 122 #include "acparser.h"
 123 #include "acdispat.h"
 124 #include "acinterp.h"
 125 #include "amlcode.h"
 126 #include "acnamesp.h"
 127 #include "actables.h"
 128
 129
 130 #define _COMPONENT          ACPI_EXECUTER
 131         ACPI_MODULE_NAME    ("exstoren")
 132
 133
 134 /*******************************************************************************
 135  *
 136  * FUNCTION:    AcpiExResolveObject
 137  *
 138  * PARAMETERS:  SourceDescPtr       - Pointer to the source object
 139  *              TargetType          - Current type of the target
 140  *              WalkState           - Current walk state
 141  *
 142  * RETURN:      Status, resolved object in SourceDescPtr.
 143  *
 144  * DESCRIPTION: Resolve an object.  If the object is a reference, dereference
 145  *              it and return the actual object in the SourceDescPtr.
 146  *
 147  ******************************************************************************/
 148
 149 ACPI_STATUS
 150 AcpiExResolveObject (
 151     ACPI_OPERAND_OBJECT     **SourceDescPtr,
 152     ACPI_OBJECT_TYPE        TargetType,
 153     ACPI_WALK_STATE         *WalkState)
 154 {
 155     ACPI_OPERAND_OBJECT     *SourceDesc = *SourceDescPtr;
 156     ACPI_STATUS             Status = AE_OK;
 157
 158
 159     ACPI_FUNCTION_TRACE ("ExResolveObject");
 160
 161
 162     /*
 163      * Ensure we have a Target that can be stored to
 164      */
 165     switch (TargetType)
 166     {
 167     case ACPI_TYPE_BUFFER_FIELD:
 168     case INTERNAL_TYPE_REGION_FIELD:
 169     case INTERNAL_TYPE_BANK_FIELD:
 170     case INTERNAL_TYPE_INDEX_FIELD:
 171         /*
 172          * These cases all require only Integers or values that
 173          * can be converted to Integers (Strings or Buffers)
 174          */
 175
 176     case ACPI_TYPE_INTEGER:
 177     case ACPI_TYPE_STRING:
 178     case ACPI_TYPE_BUFFER:
 179
 180         /*
 181          * Stores into a Field/Region or into a Integer/Buffer/String
 182          * are all essentially the same.  This case handles the
 183          * "interchangeable" types Integer, String, and Buffer.
 184          */
 185         if (SourceDesc->Common.Type == INTERNAL_TYPE_REFERENCE)
 186         {
 187             /* Resolve a reference object first */
 188
 189             Status = AcpiExResolveToValue (SourceDescPtr, WalkState);
 190             if (ACPI_FAILURE (Status))
 191             {
 192                 break;
 193             }
 194         }
 195
 196         /*
 197          * Must have a Integer, Buffer, or String
 198          */
 199         if ((SourceDesc->Common.Type != ACPI_TYPE_INTEGER)     &&
 200             (SourceDesc->Common.Type != ACPI_TYPE_BUFFER)      &&
 201             (SourceDesc->Common.Type != ACPI_TYPE_STRING))
 202         {
 203             /*
 204              * Conversion successful but still not a valid type
 205              */
 206             ACPI_DEBUG_PRINT ((ACPI_DB_ERROR,
 207                 "Cannot assign type %s to %s (must be type Int/Str/Buf)\n",
 208                 AcpiUtGetTypeName (SourceDesc->Common.Type),
 209                 AcpiUtGetTypeName (TargetType)));
 210             Status = AE_AML_OPERAND_TYPE;
 211         }
 212         break;
 213
 214
 215     case INTERNAL_TYPE_ALIAS:
 216
 217         /*
 218          * Aliases are resolved by AcpiExPrepOperands
 219          */
 220         ACPI_DEBUG_PRINT ((ACPI_DB_WARN, "Store into Alias - should never happen\n"));
 221         Status = AE_AML_INTERNAL;
 222         break;
 223
 224
 225     case ACPI_TYPE_PACKAGE:
 226     default:
 227
 228         /*
 229          * All other types than Alias and the various Fields come here,
 230          * including the untyped case - ACPI_TYPE_ANY.
 231          */
 232         break;
 233     }
 234
 235     return_ACPI_STATUS (Status);
 236 }
 237
 238
 239 /*******************************************************************************
 240  *
 241  * FUNCTION:    AcpiExStoreObjectToObject
 242  *
 243  * PARAMETERS:  SourceDesc          - Object to store
 244  *              DestDesc            - Object to recieve a copy of the source
 245  *              NewDesc             - New object if DestDesc is obsoleted
 246  *              WalkState           - Current walk state
 247  *
 248  * RETURN:      Status
 249  *
 250  * DESCRIPTION: "Store" an object to another object.  This may include
 251  *              converting the source type to the target type (implicit
 252  *              conversion), and a copy of the value of the source to
 253  *              the target.
 254  *
 255  *              The Assignment of an object to another (not named) object
 256  *              is handled here.
 257  *              The Source passed in will replace the current value (if any)
 258  *              with the input value.
 259  *
 260  *              When storing into an object the data is converted to the
 261  *              target object type then stored in the object.  This means
 262  *              that the target object type (for an initialized target) will
 263  *              not be changed by a store operation.
 264  *
 265  *              This module allows destination types of Number, String,
 266  *              Buffer, and Package.
 267  *
 268  *              Assumes parameters are already validated.  NOTE: SourceDesc
 269  *              resolution (from a reference object) must be performed by
 270  *              the caller if necessary.
 271  *
 272  ******************************************************************************/
 273
 274 ACPI_STATUS
 275 AcpiExStoreObjectToObject (
 276     ACPI_OPERAND_OBJECT     *SourceDesc,
 277     ACPI_OPERAND_OBJECT     *DestDesc,
 278     ACPI_OPERAND_OBJECT     **NewDesc,
 279     ACPI_WALK_STATE         *WalkState)
 280 {
 281     ACPI_OPERAND_OBJECT     *ActualSrcDesc;
 282     ACPI_STATUS             Status = AE_OK;
 283
 284
 285     ACPI_FUNCTION_TRACE_PTR ("AcpiExStoreObjectToObject", SourceDesc);
 286
 287
 288     ActualSrcDesc = SourceDesc;
 289     if (!DestDesc)
 290     {
 291         /*
 292          * There is no destination object (An uninitialized node or
 293          * package element), so we can simply copy the source object
 294          * creating a new destination object
 295          */
 296         Status = AcpiUtCopyIobjectToIobject (ActualSrcDesc, NewDesc, WalkState);
 297         return_ACPI_STATUS (Status);
 298     }
 299
 300     if (SourceDesc->Common.Type != DestDesc->Common.Type)
 301     {
 302         /*
 303          * The source type does not match the type of the destination.
 304          * Perform the "implicit conversion" of the source to the current type
 305          * of the target as per the ACPI specification.
 306          *
 307          * If no conversion performed, ActualSrcDesc = SourceDesc.
 308          * Otherwise, ActualSrcDesc is a temporary object to hold the
 309          * converted object.
 310          */
 311         Status = AcpiExConvertToTargetType (DestDesc->Common.Type, SourceDesc,
 312                         &ActualSrcDesc, WalkState);
 313         if (ACPI_FAILURE (Status))
 314         {
 315             return_ACPI_STATUS (Status);
 316         }
 317     }
 318
 319     /*
 320      * We now have two objects of identical types, and we can perform a
 321      * copy of the *value* of the source object.
 322      */
 323     switch (DestDesc->Common.Type)
 324     {
 325     case ACPI_TYPE_INTEGER:
 326
 327         DestDesc->Integer.Value = ActualSrcDesc->Integer.Value;
 328
 329         /* Truncate value if we are executing from a 32-bit ACPI table */
 330
 331         AcpiExTruncateFor32bitTable (DestDesc, WalkState);
 332         break;
 333
 334     case ACPI_TYPE_STRING:
 335
 336         Status = AcpiExStoreStringToString (ActualSrcDesc, DestDesc);
 337         break;
 338
 339     case ACPI_TYPE_BUFFER:
 340
 341         Status = AcpiExStoreBufferToBuffer (ActualSrcDesc, DestDesc);
 342         break;
 343
 344     case ACPI_TYPE_PACKAGE:
 345
 346         Status = AcpiUtCopyIobjectToIobject (ActualSrcDesc, &DestDesc, WalkState);
 347         break;
 348
 349     default:
 350         /*
 351          * All other types come here.
 352          */
 353         ACPI_DEBUG_PRINT ((ACPI_DB_WARN, "Store into type %s not implemented\n",
 354             AcpiUtGetTypeName (DestDesc->Common.Type)));
 355
 356         Status = AE_NOT_IMPLEMENTED;
 357         break;
 358     }
 359
 360     if (ActualSrcDesc != SourceDesc)
 361     {
 362         /* Delete the intermediate (temporary) source object */
 363
 364         AcpiUtRemoveReference (ActualSrcDesc);
 365     }
 366
 367     *NewDesc = DestDesc;
 368     return_ACPI_STATUS (Status);
 369 }
 370
 371