reactos/drivers/bus/acpi/acpica/executer/exstoren.c

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