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

   1 /******************************************************************************
   2  *
   3  * Module Name: exstorob - AML Interpreter object store support, store to object
   4  *
   5  *****************************************************************************/
   6
   7 /******************************************************************************
   8  *
   9  * 1. Copyright Notice
  10  *
  11  * Some or all of this work - Copyright (c) 1999 - 2015, Intel Corp.
  12  * All rights reserved.
  13  *
  14  * 2. License
  15  *
  16  * 2.1. This is your license from Intel Corp. under its intellectual property
  17  * rights. You may have additional license terms from the party that provided
  18  * you this software, covering your right to use that party's intellectual
  19  * property rights.
  20  *
  21  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
  22  * copy of the source code appearing in this file ("Covered Code") an
  23  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
  24  * base code distributed originally by Intel ("Original Intel Code") to copy,
  25  * make derivatives, distribute, use and display any portion of the Covered
  26  * Code in any form, with the right to sublicense such rights; and
  27  *
  28  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
  29  * license (with the right to sublicense), under only those claims of Intel
  30  * patents that are infringed by the Original Intel Code, to make, use, sell,
  31  * offer to sell, and import the Covered Code and derivative works thereof
  32  * solely to the minimum extent necessary to exercise the above copyright
  33  * license, and in no event shall the patent license extend to any additions
  34  * to or modifications of the Original Intel Code. No other license or right
  35  * is granted directly or by implication, estoppel or otherwise;
  36  *
  37  * The above copyright and patent license is granted only if the following
  38  * conditions are met:
  39  *
  40  * 3. Conditions
  41  *
  42  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
  43  * Redistribution of source code of any substantial portion of the Covered
  44  * Code or modification with rights to further distribute source must include
  45  * the above Copyright Notice, the above License, this list of Conditions,
  46  * and the following Disclaimer and Export Compliance provision. In addition,
  47  * Licensee must cause all Covered Code to which Licensee contributes to
  48  * contain a file documenting the changes Licensee made to create that Covered
  49  * Code and the date of any change. Licensee must include in that file the
  50  * documentation of any changes made by any predecessor Licensee. Licensee
  51  * must include a prominent statement that the modification is derived,
  52  * directly or indirectly, from Original Intel Code.
  53  *
  54  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
  55  * Redistribution of source code of any substantial portion of the Covered
  56  * Code or modification without rights to further distribute source must
  57  * include the following Disclaimer and Export Compliance provision in the
  58  * documentation and/or other materials provided with distribution. In
  59  * addition, Licensee may not authorize further sublicense of source of any
  60  * portion of the Covered Code, and must include terms to the effect that the
  61  * license from Licensee to its licensee is limited to the intellectual
  62  * property embodied in the software Licensee provides to its licensee, and
  63  * not to intellectual property embodied in modifications its licensee may
  64  * make.
  65  *
  66  * 3.3. Redistribution of Executable. Redistribution in executable form of any
  67  * substantial portion of the Covered Code or modification must reproduce the
  68  * above Copyright Notice, and the following Disclaimer and Export Compliance
  69  * provision in the documentation and/or other materials provided with the
  70  * distribution.
  71  *
  72  * 3.4. Intel retains all right, title, and interest in and to the Original
  73  * Intel Code.
  74  *
  75  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
  76  * Intel shall be used in advertising or otherwise to promote the sale, use or
  77  * other dealings in products derived from or relating to the Covered Code
  78  * without prior written authorization from Intel.
  79  *
  80  * 4. Disclaimer and Export Compliance
  81  *
  82  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
  83  * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
  84  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
  85  * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
  86  * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
  87  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
  88  * PARTICULAR PURPOSE.
  89  *
  90  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
  91  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
  92  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
  93  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
  94  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
  95  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
  96  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
  97  * LIMITED REMEDY.
  98  *
  99  * 4.3. Licensee shall not export, either directly or indirectly, any of this
 100  * software or system incorporating such software without first obtaining any
 101  * required license or other approval from the U. S. Department of Commerce or
 102  * any other agency or department of the United States Government. In the
 103  * event Licensee exports any such software from the United States or
 104  * re-exports any such software from a foreign destination, Licensee shall
 105  * ensure that the distribution and export/re-export of the software is in
 106  * compliance with all laws, regulations, orders, or other restrictions of the
 107  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
 108  * any of its subsidiaries will export/re-export any technical data, process,
 109  * software, or service, directly or indirectly, to any country for which the
 110  * United States government or any agency thereof requires an export license,
 111  * other governmental approval, or letter of assurance, without first obtaining
 112  * such license, approval or letter.
 113  *
 114  *****************************************************************************/
 115
 116 #include "acpi.h"
 117 #include "accommon.h"
 118 #include "acinterp.h"
 119
 120
 121 #define _COMPONENT          ACPI_EXECUTER
 122         ACPI_MODULE_NAME    ("exstorob")
 123
 124
 125 /*******************************************************************************
 126  *
 127  * FUNCTION:    AcpiExStoreBufferToBuffer
 128  *
 129  * PARAMETERS:  SourceDesc          - Source object to copy
 130  *              TargetDesc          - Destination object of the copy
 131  *
 132  * RETURN:      Status
 133  *
 134  * DESCRIPTION: Copy a buffer object to another buffer object.
 135  *
 136  ******************************************************************************/
 137
 138 ACPI_STATUS
 139 AcpiExStoreBufferToBuffer (
 140     ACPI_OPERAND_OBJECT     *SourceDesc,
 141     ACPI_OPERAND_OBJECT     *TargetDesc)
 142 {
 143     UINT32                  Length;
 144     UINT8                   *Buffer;
 145
 146
 147     ACPI_FUNCTION_TRACE_PTR (ExStoreBufferToBuffer, SourceDesc);
 148
 149
 150     /* If Source and Target are the same, just return */
 151
 152     if (SourceDesc == TargetDesc)
 153     {
 154         return_ACPI_STATUS (AE_OK);
 155     }
 156
 157     /* We know that SourceDesc is a buffer by now */
 158
 159     Buffer = ACPI_CAST_PTR (UINT8, SourceDesc->Buffer.Pointer);
 160     Length = SourceDesc->Buffer.Length;
 161
 162     /*
 163      * If target is a buffer of length zero or is a static buffer,
 164      * allocate a new buffer of the proper length
 165      */
 166     if ((TargetDesc->Buffer.Length == 0) ||
 167         (TargetDesc->Common.Flags & AOPOBJ_STATIC_POINTER))
 168     {
 169         TargetDesc->Buffer.Pointer = ACPI_ALLOCATE (Length);
 170         if (!TargetDesc->Buffer.Pointer)
 171         {
 172             return_ACPI_STATUS (AE_NO_MEMORY);
 173         }
 174
 175         TargetDesc->Buffer.Length = Length;
 176     }
 177
 178     /* Copy source buffer to target buffer */
 179
 180     if (Length <= TargetDesc->Buffer.Length)
 181     {
 182         /* Clear existing buffer and copy in the new one */
 183
 184         ACPI_MEMSET (TargetDesc->Buffer.Pointer, 0, TargetDesc->Buffer.Length);
 185         ACPI_MEMCPY (TargetDesc->Buffer.Pointer, Buffer, Length);
 186
 187 #ifdef ACPI_OBSOLETE_BEHAVIOR
 188         /*
 189          * NOTE: ACPI versions up to 3.0 specified that the buffer must be
 190          * truncated if the string is smaller than the buffer. However, "other"
 191          * implementations of ACPI never did this and thus became the defacto
 192          * standard. ACPI 3.0A changes this behavior such that the buffer
 193          * is no longer truncated.
 194          */
 195
 196         /*
 197          * OBSOLETE BEHAVIOR:
 198          * If the original source was a string, we must truncate the buffer,
 199          * according to the ACPI spec. Integer-to-Buffer and Buffer-to-Buffer
 200          * copy must not truncate the original buffer.
 201          */
 202         if (OriginalSrcType == ACPI_TYPE_STRING)
 203         {
 204             /* Set the new length of the target */
 205
 206             TargetDesc->Buffer.Length = Length;
 207         }
 208 #endif
 209     }
 210     else
 211     {
 212         /* Truncate the source, copy only what will fit */
 213
 214         ACPI_MEMCPY (TargetDesc->Buffer.Pointer, Buffer,
 215             TargetDesc->Buffer.Length);
 216
 217         ACPI_DEBUG_PRINT ((ACPI_DB_INFO,
 218             "Truncating source buffer from %X to %X\n",
 219             Length, TargetDesc->Buffer.Length));
 220     }
 221
 222     /* Copy flags */
 223
 224     TargetDesc->Buffer.Flags = SourceDesc->Buffer.Flags;
 225     TargetDesc->Common.Flags &= ~AOPOBJ_STATIC_POINTER;
 226     return_ACPI_STATUS (AE_OK);
 227 }
 228
 229
 230 /*******************************************************************************
 231  *
 232  * FUNCTION:    AcpiExStoreStringToString
 233  *
 234  * PARAMETERS:  SourceDesc          - Source object to copy
 235  *              TargetDesc          - Destination object of the copy
 236  *
 237  * RETURN:      Status
 238  *
 239  * DESCRIPTION: Copy a String object to another String object
 240  *
 241  ******************************************************************************/
 242
 243 ACPI_STATUS
 244 AcpiExStoreStringToString (
 245     ACPI_OPERAND_OBJECT     *SourceDesc,
 246     ACPI_OPERAND_OBJECT     *TargetDesc)
 247 {
 248     UINT32                  Length;
 249     UINT8                   *Buffer;
 250
 251
 252     ACPI_FUNCTION_TRACE_PTR (ExStoreStringToString, SourceDesc);
 253
 254
 255     /* If Source and Target are the same, just return */
 256
 257     if (SourceDesc == TargetDesc)
 258     {
 259         return_ACPI_STATUS (AE_OK);
 260     }
 261
 262     /* We know that SourceDesc is a string by now */
 263
 264     Buffer = ACPI_CAST_PTR (UINT8, SourceDesc->String.Pointer);
 265     Length = SourceDesc->String.Length;
 266
 267     /*
 268      * Replace existing string value if it will fit and the string
 269      * pointer is not a static pointer (part of an ACPI table)
 270      */
 271     if ((Length < TargetDesc->String.Length) &&
 272        (!(TargetDesc->Common.Flags & AOPOBJ_STATIC_POINTER)))
 273     {
 274         /*
 275          * String will fit in existing non-static buffer.
 276          * Clear old string and copy in the new one
 277          */
 278         ACPI_MEMSET (TargetDesc->String.Pointer, 0,
 279             (ACPI_SIZE) TargetDesc->String.Length + 1);
 280         ACPI_MEMCPY (TargetDesc->String.Pointer, Buffer, Length);
 281     }
 282     else
 283     {
 284         /*
 285          * Free the current buffer, then allocate a new buffer
 286          * large enough to hold the value
 287          */
 288         if (TargetDesc->String.Pointer &&
 289            (!(TargetDesc->Common.Flags & AOPOBJ_STATIC_POINTER)))
 290         {
 291             /* Only free if not a pointer into the DSDT */
 292
 293             ACPI_FREE (TargetDesc->String.Pointer);
 294         }
 295
 296         TargetDesc->String.Pointer = ACPI_ALLOCATE_ZEROED (
 297                                         (ACPI_SIZE) Length + 1);
 298         if (!TargetDesc->String.Pointer)
 299         {
 300             return_ACPI_STATUS (AE_NO_MEMORY);
 301         }
 302
 303         TargetDesc->Common.Flags &= ~AOPOBJ_STATIC_POINTER;
 304         ACPI_MEMCPY (TargetDesc->String.Pointer, Buffer, Length);
 305     }
 306
 307     /* Set the new target length */
 308
 309     TargetDesc->String.Length = Length;
 310     return_ACPI_STATUS (AE_OK);
 311 }