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: 41 $
   7  *
   8  *****************************************************************************/
   9
  10 /******************************************************************************
  11  *
  12  * 1. Copyright Notice
  13  *
  14  * Some or all of this work - Copyright (c) 1999, 2000, 2001, 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         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_TYPE8       TargetType,
 153     ACPI_WALK_STATE         *WalkState)
 154 {
 155     ACPI_OPERAND_OBJECT     *SourceDesc = *SourceDescPtr;
 156     ACPI_STATUS             Status = AE_OK;
 157
 158
 159     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
 186         /* TBD: FIX - check for source==REF, resolve, then check type */
 187
 188         /*
 189          * If SourceDesc is not a valid type, try to resolve it to one.
 190          */
 191         if ((SourceDesc->Common.Type != ACPI_TYPE_INTEGER)     &&
 192             (SourceDesc->Common.Type != ACPI_TYPE_BUFFER)      &&
 193             (SourceDesc->Common.Type != ACPI_TYPE_STRING))
 194         {
 195             /*
 196              * Initially not a valid type, convert
 197              */
 198             Status = AcpiExResolveToValue (SourceDescPtr, WalkState);
 199             if (ACPI_SUCCESS (Status) &&
 200                 (SourceDesc->Common.Type != ACPI_TYPE_INTEGER)     &&
 201                 (SourceDesc->Common.Type != ACPI_TYPE_BUFFER)      &&
 202                 (SourceDesc->Common.Type != ACPI_TYPE_STRING))
 203             {
 204                 /*
 205                  * Conversion successful but still not a valid type
 206                  */
 207                 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR,
 208                     "Cannot assign type %s to %s (must be type Int/Str/Buf)\n",
 209                     AcpiUtGetTypeName ((*SourceDescPtr)->Common.Type),
 210                     AcpiUtGetTypeName (TargetType)));
 211                 Status = AE_AML_OPERAND_TYPE;
 212             }
 213         }
 214         break;
 215
 216
 217     case INTERNAL_TYPE_ALIAS:
 218
 219         /*
 220          * Aliases are resolved by AcpiExPrepOperands
 221          */
 222         ACPI_DEBUG_PRINT ((ACPI_DB_WARN, "Store into Alias - should never happen\n"));
 223         Status = AE_AML_INTERNAL;
 224         break;
 225
 226
 227     case ACPI_TYPE_PACKAGE:
 228     default:
 229
 230         /*
 231          * All other types than Alias and the various Fields come here,
 232          * including the untyped case - ACPI_TYPE_ANY.
 233          */
 234         break;
 235     }
 236
 237     return_ACPI_STATUS (Status);
 238 }
 239
 240
 241 /*******************************************************************************
 242  *
 243  * FUNCTION:    AcpiExStoreObject
 244  *
 245  * PARAMETERS:  SourceDesc          - Object to store
 246  *              TargetType          - Current type of the target
 247  *              TargetDescPtr       - Pointer to the target
 248  *              WalkState           - Current walk state
 249  *
 250  * RETURN:      Status
 251  *
 252  * DESCRIPTION: "Store" an object to another object.  This may include
 253  *              converting the source type to the target type (implicit
 254  *              conversion), and a copy of the value of the source to
 255  *              the target.
 256  *
 257  ******************************************************************************/
 258
 259 ACPI_STATUS
 260 AcpiExStoreObject (
 261     ACPI_OPERAND_OBJECT     *SourceDesc,
 262     ACPI_OBJECT_TYPE8       TargetType,
 263     ACPI_OPERAND_OBJECT     **TargetDescPtr,
 264     ACPI_WALK_STATE         *WalkState)
 265 {
 266     ACPI_OPERAND_OBJECT     *TargetDesc = *TargetDescPtr;
 267     ACPI_STATUS             Status = AE_OK;
 268
 269
 270     FUNCTION_TRACE ("ExStoreObject");
 271
 272
 273     /*
 274      * Perform the "implicit conversion" of the source to the current type
 275      * of the target - As per the ACPI specification.
 276      *
 277      * If no conversion performed, SourceDesc is left alone, otherwise it
 278      * is updated with a new object.
 279      */
 280     Status = AcpiExConvertToTargetType (TargetType, &SourceDesc, WalkState);
 281     if (ACPI_FAILURE (Status))
 282     {
 283         return_ACPI_STATUS (Status);
 284     }
 285
 286     /*
 287      * We now have two objects of identical types, and we can perform a
 288      * copy of the *value* of the source object.
 289      */
 290     switch (TargetType)
 291     {
 292     case ACPI_TYPE_ANY:
 293     case INTERNAL_TYPE_DEF_ANY:
 294
 295         /*
 296          * The target namespace node is uninitialized (has no target object),
 297          * and will take on the type of the source object
 298          */
 299         *TargetDescPtr = SourceDesc;
 300         break;
 301
 302
 303     case ACPI_TYPE_INTEGER:
 304
 305         TargetDesc->Integer.Value = SourceDesc->Integer.Value;
 306
 307         /* Truncate value if we are executing from a 32-bit ACPI table */
 308
 309         AcpiExTruncateFor32bitTable (TargetDesc, WalkState);
 310         break;
 311
 312     case ACPI_TYPE_STRING:
 313
 314         Status = AcpiExCopyStringToString (SourceDesc, TargetDesc);
 315         break;
 316
 317
 318     case ACPI_TYPE_BUFFER:
 319
 320         Status = AcpiExCopyBufferToBuffer (SourceDesc, TargetDesc);
 321         break;
 322
 323
 324     case ACPI_TYPE_PACKAGE:
 325
 326         /*
 327          * TBD: [Unhandled] Not real sure what to do here
 328          */
 329         Status = AE_NOT_IMPLEMENTED;
 330         break;
 331
 332
 333     default:
 334
 335         /*
 336          * All other types come here.
 337          */
 338         ACPI_DEBUG_PRINT ((ACPI_DB_WARN, "Store into type %s not implemented\n",
 339             AcpiUtGetTypeName (TargetType)));
 340
 341         Status = AE_NOT_IMPLEMENTED;
 342         break;
 343     }
 344
 345
 346     return_ACPI_STATUS (Status);
 347 }
 348
 349