sys/contrib/dev/acpica/executer/exstorob.c

   1
   2 /******************************************************************************
   3  *
   4  * Module Name: exstorob - AML Interpreter object store support, store to object
   5  *
   6  *****************************************************************************/
   7
   8 /******************************************************************************
   9  *
  10  * 1. Copyright Notice
  11  *
  12  * Some or all of this work - Copyright (c) 1999 - 2010, 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 __EXSTOROB_C__
 118
 119 #include <contrib/dev/acpica/include/acpi.h>
 120 #include <contrib/dev/acpica/include/accommon.h>
 121 #include <contrib/dev/acpica/include/acinterp.h>
 122
 123
 124 #define _COMPONENT          ACPI_EXECUTER
 125         ACPI_MODULE_NAME    ("exstorob")
 126
 127
 128 /*******************************************************************************
 129  *
 130  * FUNCTION:    AcpiExStoreBufferToBuffer
 131  *
 132  * PARAMETERS:  SourceDesc          - Source object to copy
 133  *              TargetDesc          - Destination object of the copy
 134  *
 135  * RETURN:      Status
 136  *
 137  * DESCRIPTION: Copy a buffer object to another buffer object.
 138  *
 139  ******************************************************************************/
 140
 141 ACPI_STATUS
 142 AcpiExStoreBufferToBuffer (
 143     ACPI_OPERAND_OBJECT     *SourceDesc,
 144     ACPI_OPERAND_OBJECT     *TargetDesc)
 145 {
 146     UINT32                  Length;
 147     UINT8                   *Buffer;
 148
 149
 150     ACPI_FUNCTION_TRACE_PTR (ExStoreBufferToBuffer, SourceDesc);
 151
 152
 153     /* If Source and Target are the same, just return */
 154
 155     if (SourceDesc == TargetDesc)
 156     {
 157         return_ACPI_STATUS (AE_OK);
 158     }
 159
 160     /* We know that SourceDesc is a buffer by now */
 161
 162     Buffer = ACPI_CAST_PTR (UINT8, SourceDesc->Buffer.Pointer);
 163     Length = SourceDesc->Buffer.Length;
 164
 165     /*
 166      * If target is a buffer of length zero or is a static buffer,
 167      * allocate a new buffer of the proper length
 168      */
 169     if ((TargetDesc->Buffer.Length == 0) ||
 170         (TargetDesc->Common.Flags & AOPOBJ_STATIC_POINTER))
 171     {
 172         TargetDesc->Buffer.Pointer = ACPI_ALLOCATE (Length);
 173         if (!TargetDesc->Buffer.Pointer)
 174         {
 175             return_ACPI_STATUS (AE_NO_MEMORY);
 176         }
 177
 178         TargetDesc->Buffer.Length = Length;
 179     }
 180
 181     /* Copy source buffer to target buffer */
 182
 183     if (Length <= TargetDesc->Buffer.Length)
 184     {
 185         /* Clear existing buffer and copy in the new one */
 186
 187         ACPI_MEMSET (TargetDesc->Buffer.Pointer, 0, TargetDesc->Buffer.Length);
 188         ACPI_MEMCPY (TargetDesc->Buffer.Pointer, Buffer, Length);
 189
 190 #ifdef ACPI_OBSOLETE_BEHAVIOR
 191         /*
 192          * NOTE: ACPI versions up to 3.0 specified that the buffer must be
 193          * truncated if the string is smaller than the buffer.  However, "other"
 194          * implementations of ACPI never did this and thus became the defacto
 195          * standard. ACPI 3.0A changes this behavior such that the buffer
 196          * is no longer truncated.
 197          */
 198
 199         /*
 200          * OBSOLETE BEHAVIOR:
 201          * If the original source was a string, we must truncate the buffer,
 202          * according to the ACPI spec.  Integer-to-Buffer and Buffer-to-Buffer
 203          * copy must not truncate the original buffer.
 204          */
 205         if (OriginalSrcType == ACPI_TYPE_STRING)
 206         {
 207             /* Set the new length of the target */
 208
 209             TargetDesc->Buffer.Length = Length;
 210         }
 211 #endif
 212     }
 213     else
 214     {
 215         /* Truncate the source, copy only what will fit */
 216
 217         ACPI_MEMCPY (TargetDesc->Buffer.Pointer, Buffer,
 218             TargetDesc->Buffer.Length);
 219
 220         ACPI_DEBUG_PRINT ((ACPI_DB_INFO,
 221             "Truncating source buffer from %X to %X\n",
 222             Length, TargetDesc->Buffer.Length));
 223     }
 224
 225     /* Copy flags */
 226
 227     TargetDesc->Buffer.Flags = SourceDesc->Buffer.Flags;
 228     TargetDesc->Common.Flags &= ~AOPOBJ_STATIC_POINTER;
 229     return_ACPI_STATUS (AE_OK);
 230 }
 231
 232
 233 /*******************************************************************************
 234  *
 235  * FUNCTION:    AcpiExStoreStringToString
 236  *
 237  * PARAMETERS:  SourceDesc          - Source object to copy
 238  *              TargetDesc          - Destination object of the copy
 239  *
 240  * RETURN:      Status
 241  *
 242  * DESCRIPTION: Copy a String object to another String object
 243  *
 244  ******************************************************************************/
 245
 246 ACPI_STATUS
 247 AcpiExStoreStringToString (
 248     ACPI_OPERAND_OBJECT     *SourceDesc,
 249     ACPI_OPERAND_OBJECT     *TargetDesc)
 250 {
 251     UINT32                  Length;
 252     UINT8                   *Buffer;
 253
 254
 255     ACPI_FUNCTION_TRACE_PTR (ExStoreStringToString, SourceDesc);
 256
 257
 258     /* If Source and Target are the same, just return */
 259
 260     if (SourceDesc == TargetDesc)
 261     {
 262         return_ACPI_STATUS (AE_OK);
 263     }
 264
 265     /* We know that SourceDesc is a string by now */
 266
 267     Buffer = ACPI_CAST_PTR (UINT8, SourceDesc->String.Pointer);
 268     Length = SourceDesc->String.Length;
 269
 270     /*
 271      * Replace existing string value if it will fit and the string
 272      * pointer is not a static pointer (part of an ACPI table)
 273      */
 274     if ((Length < TargetDesc->String.Length) &&
 275        (!(TargetDesc->Common.Flags & AOPOBJ_STATIC_POINTER)))
 276     {
 277         /*
 278          * String will fit in existing non-static buffer.
 279          * Clear old string and copy in the new one
 280          */
 281         ACPI_MEMSET (TargetDesc->String.Pointer, 0,
 282             (ACPI_SIZE) TargetDesc->String.Length + 1);
 283         ACPI_MEMCPY (TargetDesc->String.Pointer, Buffer, Length);
 284     }
 285     else
 286     {
 287         /*
 288          * Free the current buffer, then allocate a new buffer
 289          * large enough to hold the value
 290          */
 291         if (TargetDesc->String.Pointer &&
 292            (!(TargetDesc->Common.Flags & AOPOBJ_STATIC_POINTER)))
 293         {
 294             /* Only free if not a pointer into the DSDT */
 295
 296             ACPI_FREE (TargetDesc->String.Pointer);
 297         }
 298
 299         TargetDesc->String.Pointer = ACPI_ALLOCATE_ZEROED (
 300                                         (ACPI_SIZE) Length + 1);
 301         if (!TargetDesc->String.Pointer)
 302         {
 303             return_ACPI_STATUS (AE_NO_MEMORY);
 304         }
 305
 306         TargetDesc->Common.Flags &= ~AOPOBJ_STATIC_POINTER;
 307         ACPI_MEMCPY (TargetDesc->String.Pointer, Buffer, Length);
 308     }
 309
 310     /* Set the new target length */
 311
 312     TargetDesc->String.Length = Length;
 313     return_ACPI_STATUS (AE_OK);
 314 }
 315
 316