Back to home page

LXR

 
 

    


File indexing completed on 2025-05-11 08:24:02

0001 /******************************************************************************
0002  *
0003  * Module Name: exstorob - AML object store support, store to object
0004  *
0005  *****************************************************************************/
0006 
0007 /******************************************************************************
0008  *
0009  * 1. Copyright Notice
0010  *
0011  * Some or all of this work - Copyright (c) 1999 - 2024, Intel Corp.
0012  * All rights reserved.
0013  *
0014  * 2. License
0015  *
0016  * 2.1. This is your license from Intel Corp. under its intellectual property
0017  * rights. You may have additional license terms from the party that provided
0018  * you this software, covering your right to use that party's intellectual
0019  * property rights.
0020  *
0021  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
0022  * copy of the source code appearing in this file ("Covered Code") an
0023  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
0024  * base code distributed originally by Intel ("Original Intel Code") to copy,
0025  * make derivatives, distribute, use and display any portion of the Covered
0026  * Code in any form, with the right to sublicense such rights; and
0027  *
0028  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
0029  * license (with the right to sublicense), under only those claims of Intel
0030  * patents that are infringed by the Original Intel Code, to make, use, sell,
0031  * offer to sell, and import the Covered Code and derivative works thereof
0032  * solely to the minimum extent necessary to exercise the above copyright
0033  * license, and in no event shall the patent license extend to any additions
0034  * to or modifications of the Original Intel Code. No other license or right
0035  * is granted directly or by implication, estoppel or otherwise;
0036  *
0037  * The above copyright and patent license is granted only if the following
0038  * conditions are met:
0039  *
0040  * 3. Conditions
0041  *
0042  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
0043  * Redistribution of source code of any substantial portion of the Covered
0044  * Code or modification with rights to further distribute source must include
0045  * the above Copyright Notice, the above License, this list of Conditions,
0046  * and the following Disclaimer and Export Compliance provision. In addition,
0047  * Licensee must cause all Covered Code to which Licensee contributes to
0048  * contain a file documenting the changes Licensee made to create that Covered
0049  * Code and the date of any change. Licensee must include in that file the
0050  * documentation of any changes made by any predecessor Licensee. Licensee
0051  * must include a prominent statement that the modification is derived,
0052  * directly or indirectly, from Original Intel Code.
0053  *
0054  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
0055  * Redistribution of source code of any substantial portion of the Covered
0056  * Code or modification without rights to further distribute source must
0057  * include the following Disclaimer and Export Compliance provision in the
0058  * documentation and/or other materials provided with distribution. In
0059  * addition, Licensee may not authorize further sublicense of source of any
0060  * portion of the Covered Code, and must include terms to the effect that the
0061  * license from Licensee to its licensee is limited to the intellectual
0062  * property embodied in the software Licensee provides to its licensee, and
0063  * not to intellectual property embodied in modifications its licensee may
0064  * make.
0065  *
0066  * 3.3. Redistribution of Executable. Redistribution in executable form of any
0067  * substantial portion of the Covered Code or modification must reproduce the
0068  * above Copyright Notice, and the following Disclaimer and Export Compliance
0069  * provision in the documentation and/or other materials provided with the
0070  * distribution.
0071  *
0072  * 3.4. Intel retains all right, title, and interest in and to the Original
0073  * Intel Code.
0074  *
0075  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
0076  * Intel shall be used in advertising or otherwise to promote the sale, use or
0077  * other dealings in products derived from or relating to the Covered Code
0078  * without prior written authorization from Intel.
0079  *
0080  * 4. Disclaimer and Export Compliance
0081  *
0082  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
0083  * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
0084  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
0085  * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
0086  * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
0087  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
0088  * PARTICULAR PURPOSE.
0089  *
0090  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
0091  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
0092  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
0093  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
0094  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
0095  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
0096  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
0097  * LIMITED REMEDY.
0098  *
0099  * 4.3. Licensee shall not export, either directly or indirectly, any of this
0100  * software or system incorporating such software without first obtaining any
0101  * required license or other approval from the U. S. Department of Commerce or
0102  * any other agency or department of the United States Government. In the
0103  * event Licensee exports any such software from the United States or
0104  * re-exports any such software from a foreign destination, Licensee shall
0105  * ensure that the distribution and export/re-export of the software is in
0106  * compliance with all laws, regulations, orders, or other restrictions of the
0107  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
0108  * any of its subsidiaries will export/re-export any technical data, process,
0109  * software, or service, directly or indirectly, to any country for which the
0110  * United States government or any agency thereof requires an export license,
0111  * other governmental approval, or letter of assurance, without first obtaining
0112  * such license, approval or letter.
0113  *
0114  *****************************************************************************
0115  *
0116  * Alternatively, you may choose to be licensed under the terms of the
0117  * following license:
0118  *
0119  * Redistribution and use in source and binary forms, with or without
0120  * modification, are permitted provided that the following conditions
0121  * are met:
0122  * 1. Redistributions of source code must retain the above copyright
0123  *    notice, this list of conditions, and the following disclaimer,
0124  *    without modification.
0125  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
0126  *    substantially similar to the "NO WARRANTY" disclaimer below
0127  *    ("Disclaimer") and any redistribution must be conditioned upon
0128  *    including a substantially similar Disclaimer requirement for further
0129  *    binary redistribution.
0130  * 3. Neither the names of the above-listed copyright holders nor the names
0131  *    of any contributors may be used to endorse or promote products derived
0132  *    from this software without specific prior written permission.
0133  *
0134  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
0135  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
0136  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
0137  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
0138  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
0139  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
0140  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
0141  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
0142  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
0143  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
0144  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
0145  *
0146  * Alternatively, you may choose to be licensed under the terms of the
0147  * GNU General Public License ("GPL") version 2 as published by the Free
0148  * Software Foundation.
0149  *
0150  *****************************************************************************/
0151 
0152 #include "acpi.h"
0153 #include "accommon.h"
0154 #include "acinterp.h"
0155 
0156 
0157 #define _COMPONENT          ACPI_EXECUTER
0158         ACPI_MODULE_NAME    ("exstorob")
0159 
0160 
0161 /*******************************************************************************
0162  *
0163  * FUNCTION:    AcpiExStoreBufferToBuffer
0164  *
0165  * PARAMETERS:  SourceDesc          - Source object to copy
0166  *              TargetDesc          - Destination object of the copy
0167  *
0168  * RETURN:      Status
0169  *
0170  * DESCRIPTION: Copy a buffer object to another buffer object.
0171  *
0172  ******************************************************************************/
0173 
0174 ACPI_STATUS
0175 AcpiExStoreBufferToBuffer (
0176     ACPI_OPERAND_OBJECT     *SourceDesc,
0177     ACPI_OPERAND_OBJECT     *TargetDesc)
0178 {
0179     UINT32                  Length;
0180     UINT8                   *Buffer;
0181 
0182 
0183     ACPI_FUNCTION_TRACE_PTR (ExStoreBufferToBuffer, SourceDesc);
0184 
0185 
0186     /* If Source and Target are the same, just return */
0187 
0188     if (SourceDesc == TargetDesc)
0189     {
0190         return_ACPI_STATUS (AE_OK);
0191     }
0192 
0193     /* We know that SourceDesc is a buffer by now */
0194 
0195     Buffer = ACPI_CAST_PTR (UINT8, SourceDesc->Buffer.Pointer);
0196     Length = SourceDesc->Buffer.Length;
0197 
0198     /*
0199      * If target is a buffer of length zero or is a static buffer,
0200      * allocate a new buffer of the proper length
0201      */
0202     if ((TargetDesc->Buffer.Length == 0) ||
0203         (TargetDesc->Common.Flags & AOPOBJ_STATIC_POINTER))
0204     {
0205         TargetDesc->Buffer.Pointer = ACPI_ALLOCATE (Length);
0206         if (!TargetDesc->Buffer.Pointer)
0207         {
0208             return_ACPI_STATUS (AE_NO_MEMORY);
0209         }
0210 
0211         TargetDesc->Buffer.Length = Length;
0212     }
0213 
0214     /* Copy source buffer to target buffer */
0215 
0216     if (Length <= TargetDesc->Buffer.Length)
0217     {
0218         /* Clear existing buffer and copy in the new one */
0219 
0220         memset (TargetDesc->Buffer.Pointer, 0, TargetDesc->Buffer.Length);
0221         memcpy (TargetDesc->Buffer.Pointer, Buffer, Length);
0222 
0223 #ifdef ACPI_OBSOLETE_BEHAVIOR
0224         /*
0225          * NOTE: ACPI versions up to 3.0 specified that the buffer must be
0226          * truncated if the string is smaller than the buffer. However, "other"
0227          * implementations of ACPI never did this and thus became the defacto
0228          * standard. ACPI 3.0A changes this behavior such that the buffer
0229          * is no longer truncated.
0230          */
0231 
0232         /*
0233          * OBSOLETE BEHAVIOR:
0234          * If the original source was a string, we must truncate the buffer,
0235          * according to the ACPI spec. Integer-to-Buffer and Buffer-to-Buffer
0236          * copy must not truncate the original buffer.
0237          */
0238         if (OriginalSrcType == ACPI_TYPE_STRING)
0239         {
0240             /* Set the new length of the target */
0241 
0242             TargetDesc->Buffer.Length = Length;
0243         }
0244 #endif
0245     }
0246     else
0247     {
0248         /* Truncate the source, copy only what will fit */
0249 
0250         memcpy (TargetDesc->Buffer.Pointer, Buffer,
0251             TargetDesc->Buffer.Length);
0252 
0253         ACPI_DEBUG_PRINT ((ACPI_DB_INFO,
0254             "Truncating source buffer from %X to %X\n",
0255             Length, TargetDesc->Buffer.Length));
0256     }
0257 
0258     /* Copy flags */
0259 
0260     TargetDesc->Buffer.Flags = SourceDesc->Buffer.Flags;
0261     TargetDesc->Common.Flags &= ~AOPOBJ_STATIC_POINTER;
0262     return_ACPI_STATUS (AE_OK);
0263 }
0264 
0265 
0266 /*******************************************************************************
0267  *
0268  * FUNCTION:    AcpiExStoreStringToString
0269  *
0270  * PARAMETERS:  SourceDesc          - Source object to copy
0271  *              TargetDesc          - Destination object of the copy
0272  *
0273  * RETURN:      Status
0274  *
0275  * DESCRIPTION: Copy a String object to another String object
0276  *
0277  ******************************************************************************/
0278 
0279 ACPI_STATUS
0280 AcpiExStoreStringToString (
0281     ACPI_OPERAND_OBJECT     *SourceDesc,
0282     ACPI_OPERAND_OBJECT     *TargetDesc)
0283 {
0284     UINT32                  Length;
0285     UINT8                   *Buffer;
0286 
0287 
0288     ACPI_FUNCTION_TRACE_PTR (ExStoreStringToString, SourceDesc);
0289 
0290 
0291     /* If Source and Target are the same, just return */
0292 
0293     if (SourceDesc == TargetDesc)
0294     {
0295         return_ACPI_STATUS (AE_OK);
0296     }
0297 
0298     /* We know that SourceDesc is a string by now */
0299 
0300     Buffer = ACPI_CAST_PTR (UINT8, SourceDesc->String.Pointer);
0301     Length = SourceDesc->String.Length;
0302 
0303     /*
0304      * Replace existing string value if it will fit and the string
0305      * pointer is not a static pointer (part of an ACPI table)
0306      */
0307     if ((Length < TargetDesc->String.Length) &&
0308        (!(TargetDesc->Common.Flags & AOPOBJ_STATIC_POINTER)))
0309     {
0310         /*
0311          * String will fit in existing non-static buffer.
0312          * Clear old string and copy in the new one
0313          */
0314         memset (TargetDesc->String.Pointer, 0,
0315             (ACPI_SIZE) TargetDesc->String.Length + 1);
0316         memcpy (TargetDesc->String.Pointer, Buffer, Length);
0317     }
0318     else
0319     {
0320         /*
0321          * Free the current buffer, then allocate a new buffer
0322          * large enough to hold the value
0323          */
0324         if (TargetDesc->String.Pointer &&
0325            (!(TargetDesc->Common.Flags & AOPOBJ_STATIC_POINTER)))
0326         {
0327             /* Only free if not a pointer into the DSDT */
0328 
0329             ACPI_FREE (TargetDesc->String.Pointer);
0330         }
0331 
0332         TargetDesc->String.Pointer =
0333             ACPI_ALLOCATE_ZEROED ((ACPI_SIZE) Length + 1);
0334 
0335         if (!TargetDesc->String.Pointer)
0336         {
0337             return_ACPI_STATUS (AE_NO_MEMORY);
0338         }
0339 
0340         TargetDesc->Common.Flags &= ~AOPOBJ_STATIC_POINTER;
0341         memcpy (TargetDesc->String.Pointer, Buffer, Length);
0342     }
0343 
0344     /* Set the new target length */
0345 
0346     TargetDesc->String.Length = Length;
0347     return_ACPI_STATUS (AE_OK);
0348 }