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 - 2014, 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 #define __EXSTOREN_C__
 118
 119 #include "acpi.h"
 120 #include "accommon.h"
 121 #include "acinterp.h"
 122 #include "amlcode.h"
 123
 124
 125 #define _COMPONENT          ACPI_EXECUTER
 126         ACPI_MODULE_NAME    ("exstoren")
 127
 128
 129 /*******************************************************************************
 130  *
 131  * FUNCTION:    AcpiExResolveObject
 132  *
 133  * PARAMETERS:  SourceDescPtr       - Pointer to the source object
 134  *              TargetType          - Current type of the target
 135  *              WalkState           - Current walk state
 136  *
 137  * RETURN:      Status, resolved object in SourceDescPtr.
 138  *
 139  * DESCRIPTION: Resolve an object. If the object is a reference, dereference
 140  *              it and return the actual object in the SourceDescPtr.
 141  *
 142  ******************************************************************************/
 143
 144 ACPI_STATUS
 145 AcpiExResolveObject (
 146     ACPI_OPERAND_OBJECT     **SourceDescPtr,
 147     ACPI_OBJECT_TYPE        TargetType,
 148     ACPI_WALK_STATE         *WalkState)
 149 {
 150     ACPI_OPERAND_OBJECT     *SourceDesc = *SourceDescPtr;
 151     ACPI_STATUS             Status = AE_OK;
 152
 153
 154     ACPI_FUNCTION_TRACE (ExResolveObject);
 155
 156
 157     /* Ensure we have a Target that can be stored to */
 158
 159     switch (TargetType)
 160     {
 161     case ACPI_TYPE_BUFFER_FIELD:
 162     case ACPI_TYPE_LOCAL_REGION_FIELD:
 163     case ACPI_TYPE_LOCAL_BANK_FIELD:
 164     case ACPI_TYPE_LOCAL_INDEX_FIELD:
 165         /*
 166          * These cases all require only Integers or values that
 167          * can be converted to Integers (Strings or Buffers)
 168          */
 169     case ACPI_TYPE_INTEGER:
 170     case ACPI_TYPE_STRING:
 171     case ACPI_TYPE_BUFFER:
 172         /*
 173          * Stores into a Field/Region or into a Integer/Buffer/String
 174          * are all essentially the same. This case handles the
 175          * "interchangeable" types Integer, String, and Buffer.
 176          */
 177         if (SourceDesc->Common.Type == ACPI_TYPE_LOCAL_REFERENCE)
 178         {
 179             /* Resolve a reference object first */
 180
 181             Status = AcpiExResolveToValue (SourceDescPtr, WalkState);
 182             if (ACPI_FAILURE (Status))
 183             {
 184                 break;
 185             }
 186         }
 187
 188         /* For CopyObject, no further validation necessary */
 189
 190         if (WalkState->Opcode == AML_COPY_OP)
 191         {
 192             break;
 193         }
 194
 195         /* Must have a Integer, Buffer, or String */
 196
 197         if ((SourceDesc->Common.Type != ACPI_TYPE_INTEGER)    &&
 198             (SourceDesc->Common.Type != ACPI_TYPE_BUFFER)     &&
 199             (SourceDesc->Common.Type != ACPI_TYPE_STRING)     &&
 200             !((SourceDesc->Common.Type == ACPI_TYPE_LOCAL_REFERENCE) &&
 201                     (SourceDesc->Reference.Class== ACPI_REFCLASS_TABLE)))
 202         {
 203             /* Conversion successful but still not a valid type */
 204
 205             ACPI_ERROR ((AE_INFO,
 206                 "Cannot assign type %s to %s (must be type Int/Str/Buf)",
 207                 AcpiUtGetObjectTypeName (SourceDesc),
 208                 AcpiUtGetTypeName (TargetType)));
 209             Status = AE_AML_OPERAND_TYPE;
 210         }
 211         break;
 212
 213     case ACPI_TYPE_LOCAL_ALIAS:
 214     case ACPI_TYPE_LOCAL_METHOD_ALIAS:
 215         /*
 216          * All aliases should have been resolved earlier, during the
 217          * operand resolution phase.
 218          */
 219         ACPI_ERROR ((AE_INFO, "Store into an unresolved Alias object"));
 220         Status = AE_AML_INTERNAL;
 221         break;
 222
 223     case ACPI_TYPE_PACKAGE:
 224     default:
 225         /*
 226          * All other types than Alias and the various Fields come here,
 227          * including the untyped case - ACPI_TYPE_ANY.
 228          */
 229         break;
 230     }
 231
 232     return_ACPI_STATUS (Status);
 233 }
 234
 235
 236 /*******************************************************************************
 237  *
 238  * FUNCTION:    AcpiExStoreObjectToObject
 239  *
 240  * PARAMETERS:  SourceDesc          - Object to store
 241  *              DestDesc            - Object to receive a copy of the source
 242  *              NewDesc             - New object if DestDesc is obsoleted
 243  *              WalkState           - Current walk state
 244  *
 245  * RETURN:      Status
 246  *
 247  * DESCRIPTION: "Store" an object to another object. This may include
 248  *              converting the source type to the target type (implicit
 249  *              conversion), and a copy of the value of the source to
 250  *              the target.
 251  *
 252  *              The Assignment of an object to another (not named) object
 253  *              is handled here.
 254  *              The Source passed in will replace the current value (if any)
 255  *              with the input value.
 256  *
 257  *              When storing into an object the data is converted to the
 258  *              target object type then stored in the object. This means
 259  *              that the target object type (for an initialized target) will
 260  *              not be changed by a store operation.
 261  *
 262  *              This module allows destination types of Number, String,
 263  *              Buffer, and Package.
 264  *
 265  *              Assumes parameters are already validated. NOTE: SourceDesc
 266  *              resolution (from a reference object) must be performed by
 267  *              the caller if necessary.
 268  *
 269  ******************************************************************************/
 270
 271 ACPI_STATUS
 272 AcpiExStoreObjectToObject (
 273     ACPI_OPERAND_OBJECT     *SourceDesc,
 274     ACPI_OPERAND_OBJECT     *DestDesc,
 275     ACPI_OPERAND_OBJECT     **NewDesc,
 276     ACPI_WALK_STATE         *WalkState)
 277 {
 278     ACPI_OPERAND_OBJECT     *ActualSrcDesc;
 279     ACPI_STATUS             Status = AE_OK;
 280
 281
 282     ACPI_FUNCTION_TRACE_PTR (ExStoreObjectToObject, SourceDesc);
 283
 284
 285     ActualSrcDesc = SourceDesc;
 286     if (!DestDesc)
 287     {
 288         /*
 289          * There is no destination object (An uninitialized node or
 290          * package element), so we can simply copy the source object
 291          * creating a new destination object
 292          */
 293         Status = AcpiUtCopyIobjectToIobject (ActualSrcDesc, NewDesc, WalkState);
 294         return_ACPI_STATUS (Status);
 295     }
 296
 297     if (SourceDesc->Common.Type != DestDesc->Common.Type)
 298     {
 299         /*
 300          * The source type does not match the type of the destination.
 301          * Perform the "implicit conversion" of the source to the current type
 302          * of the target as per the ACPI specification.
 303          *
 304          * If no conversion performed, ActualSrcDesc = SourceDesc.
 305          * Otherwise, ActualSrcDesc is a temporary object to hold the
 306          * converted object.
 307          */
 308         Status = AcpiExConvertToTargetType (DestDesc->Common.Type,
 309                         SourceDesc, &ActualSrcDesc, WalkState);
 310         if (ACPI_FAILURE (Status))
 311         {
 312             return_ACPI_STATUS (Status);
 313         }
 314
 315         if (SourceDesc == ActualSrcDesc)
 316         {
 317             /*
 318              * No conversion was performed. Return the SourceDesc as the
 319              * new object.
 320              */
 321             *NewDesc = SourceDesc;
 322             return_ACPI_STATUS (AE_OK);
 323         }
 324     }
 325
 326     /*
 327      * We now have two objects of identical types, and we can perform a
 328      * copy of the *value* of the source object.
 329      */
 330     switch (DestDesc->Common.Type)
 331     {
 332     case ACPI_TYPE_INTEGER:
 333
 334         DestDesc->Integer.Value = ActualSrcDesc->Integer.Value;
 335
 336         /* Truncate value if we are executing from a 32-bit ACPI table */
 337
 338         (void) AcpiExTruncateFor32bitTable (DestDesc);
 339         break;
 340
 341     case ACPI_TYPE_STRING:
 342
 343         Status = AcpiExStoreStringToString (ActualSrcDesc, DestDesc);
 344         break;
 345
 346     case ACPI_TYPE_BUFFER:
 347
 348         Status = AcpiExStoreBufferToBuffer (ActualSrcDesc, DestDesc);
 349         break;
 350
 351     case ACPI_TYPE_PACKAGE:
 352
 353         Status = AcpiUtCopyIobjectToIobject (ActualSrcDesc, &DestDesc,
 354                     WalkState);
 355         break;
 356
 357     default:
 358         /*
 359          * All other types come here.
 360          */
 361         ACPI_WARNING ((AE_INFO, "Store into type %s not implemented",
 362             AcpiUtGetObjectTypeName (DestDesc)));
 363
 364         Status = AE_NOT_IMPLEMENTED;
 365         break;
 366     }
 367
 368     if (ActualSrcDesc != SourceDesc)
 369     {
 370         /* Delete the intermediate (temporary) source object */
 371
 372         AcpiUtRemoveReference (ActualSrcDesc);
 373     }
 374
 375     *NewDesc = DestDesc;
 376     return_ACPI_STATUS (Status);
 377 }