1/******************************************************************************
2 *
3 * Module Name: exstorob - AML 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 - 2018, 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 * Alternatively, you may choose to be licensed under the terms of the
117 * following license:
118 *
119 * Redistribution and use in source and binary forms, with or without
120 * modification, are permitted provided that the following conditions
121 * are met:
122 * 1. Redistributions of source code must retain the above copyright
123 *    notice, this list of conditions, and the following disclaimer,
124 *    without modification.
125 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
126 *    substantially similar to the "NO WARRANTY" disclaimer below
127 *    ("Disclaimer") and any redistribution must be conditioned upon
128 *    including a substantially similar Disclaimer requirement for further
129 *    binary redistribution.
130 * 3. Neither the names of the above-listed copyright holders nor the names
131 *    of any contributors may be used to endorse or promote products derived
132 *    from this software without specific prior written permission.
133 *
134 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
135 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
136 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
137 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
138 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
139 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
140 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
141 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
142 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
143 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
144 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
145 *
146 * Alternatively, you may choose to be licensed under the terms of the
147 * GNU General Public License ("GPL") version 2 as published by the Free
148 * Software Foundation.
149 *
150 *****************************************************************************/
151
152#include "acpi.h"
153#include "accommon.h"
154#include "acinterp.h"
155
156
157#define _COMPONENT          ACPI_EXECUTER
158        ACPI_MODULE_NAME    ("exstorob")
159
160
161/*******************************************************************************
162 *
163 * FUNCTION:    AcpiExStoreBufferToBuffer
164 *
165 * PARAMETERS:  SourceDesc          - Source object to copy
166 *              TargetDesc          - Destination object of the copy
167 *
168 * RETURN:      Status
169 *
170 * DESCRIPTION: Copy a buffer object to another buffer object.
171 *
172 ******************************************************************************/
173
174ACPI_STATUS
175AcpiExStoreBufferToBuffer (
176    ACPI_OPERAND_OBJECT     *SourceDesc,
177    ACPI_OPERAND_OBJECT     *TargetDesc)
178{
179    UINT32                  Length;
180    UINT8                   *Buffer;
181
182
183    ACPI_FUNCTION_TRACE_PTR (ExStoreBufferToBuffer, SourceDesc);
184
185
186    /* If Source and Target are the same, just return */
187
188    if (SourceDesc == TargetDesc)
189    {
190        return_ACPI_STATUS (AE_OK);
191    }
192
193    /* We know that SourceDesc is a buffer by now */
194
195    Buffer = ACPI_CAST_PTR (UINT8, SourceDesc->Buffer.Pointer);
196    Length = SourceDesc->Buffer.Length;
197
198    /*
199     * If target is a buffer of length zero or is a static buffer,
200     * allocate a new buffer of the proper length
201     */
202    if ((TargetDesc->Buffer.Length == 0) ||
203        (TargetDesc->Common.Flags & AOPOBJ_STATIC_POINTER))
204    {
205        TargetDesc->Buffer.Pointer = ACPI_ALLOCATE (Length);
206        if (!TargetDesc->Buffer.Pointer)
207        {
208            return_ACPI_STATUS (AE_NO_MEMORY);
209        }
210
211        TargetDesc->Buffer.Length = Length;
212    }
213
214    /* Copy source buffer to target buffer */
215
216    if (Length <= TargetDesc->Buffer.Length)
217    {
218        /* Clear existing buffer and copy in the new one */
219
220        memset (TargetDesc->Buffer.Pointer, 0, TargetDesc->Buffer.Length);
221        memcpy (TargetDesc->Buffer.Pointer, Buffer, Length);
222
223#ifdef ACPI_OBSOLETE_BEHAVIOR
224        /*
225         * NOTE: ACPI versions up to 3.0 specified that the buffer must be
226         * truncated if the string is smaller than the buffer. However, "other"
227         * implementations of ACPI never did this and thus became the defacto
228         * standard. ACPI 3.0A changes this behavior such that the buffer
229         * is no longer truncated.
230         */
231
232        /*
233         * OBSOLETE BEHAVIOR:
234         * If the original source was a string, we must truncate the buffer,
235         * according to the ACPI spec. Integer-to-Buffer and Buffer-to-Buffer
236         * copy must not truncate the original buffer.
237         */
238        if (OriginalSrcType == ACPI_TYPE_STRING)
239        {
240            /* Set the new length of the target */
241
242            TargetDesc->Buffer.Length = Length;
243        }
244#endif
245    }
246    else
247    {
248        /* Truncate the source, copy only what will fit */
249
250        memcpy (TargetDesc->Buffer.Pointer, Buffer,
251            TargetDesc->Buffer.Length);
252
253        ACPI_DEBUG_PRINT ((ACPI_DB_INFO,
254            "Truncating source buffer from %X to %X\n",
255            Length, TargetDesc->Buffer.Length));
256    }
257
258    /* Copy flags */
259
260    TargetDesc->Buffer.Flags = SourceDesc->Buffer.Flags;
261    TargetDesc->Common.Flags &= ~AOPOBJ_STATIC_POINTER;
262    return_ACPI_STATUS (AE_OK);
263}
264
265
266/*******************************************************************************
267 *
268 * FUNCTION:    AcpiExStoreStringToString
269 *
270 * PARAMETERS:  SourceDesc          - Source object to copy
271 *              TargetDesc          - Destination object of the copy
272 *
273 * RETURN:      Status
274 *
275 * DESCRIPTION: Copy a String object to another String object
276 *
277 ******************************************************************************/
278
279ACPI_STATUS
280AcpiExStoreStringToString (
281    ACPI_OPERAND_OBJECT     *SourceDesc,
282    ACPI_OPERAND_OBJECT     *TargetDesc)
283{
284    UINT32                  Length;
285    UINT8                   *Buffer;
286
287
288    ACPI_FUNCTION_TRACE_PTR (ExStoreStringToString, SourceDesc);
289
290
291    /* If Source and Target are the same, just return */
292
293    if (SourceDesc == TargetDesc)
294    {
295        return_ACPI_STATUS (AE_OK);
296    }
297
298    /* We know that SourceDesc is a string by now */
299
300    Buffer = ACPI_CAST_PTR (UINT8, SourceDesc->String.Pointer);
301    Length = SourceDesc->String.Length;
302
303    /*
304     * Replace existing string value if it will fit and the string
305     * pointer is not a static pointer (part of an ACPI table)
306     */
307    if ((Length < TargetDesc->String.Length) &&
308       (!(TargetDesc->Common.Flags & AOPOBJ_STATIC_POINTER)))
309    {
310        /*
311         * String will fit in existing non-static buffer.
312         * Clear old string and copy in the new one
313         */
314        memset (TargetDesc->String.Pointer, 0,
315            (ACPI_SIZE) TargetDesc->String.Length + 1);
316        memcpy (TargetDesc->String.Pointer, Buffer, Length);
317    }
318    else
319    {
320        /*
321         * Free the current buffer, then allocate a new buffer
322         * large enough to hold the value
323         */
324        if (TargetDesc->String.Pointer &&
325           (!(TargetDesc->Common.Flags & AOPOBJ_STATIC_POINTER)))
326        {
327            /* Only free if not a pointer into the DSDT */
328
329            ACPI_FREE (TargetDesc->String.Pointer);
330        }
331
332        TargetDesc->String.Pointer =
333            ACPI_ALLOCATE_ZEROED ((ACPI_SIZE) Length + 1);
334
335        if (!TargetDesc->String.Pointer)
336        {
337            return_ACPI_STATUS (AE_NO_MEMORY);
338        }
339
340        TargetDesc->Common.Flags &= ~AOPOBJ_STATIC_POINTER;
341        memcpy (TargetDesc->String.Pointer, Buffer, Length);
342    }
343
344    /* Set the new target length */
345
346    TargetDesc->String.Length = Length;
347    return_ACPI_STATUS (AE_OK);
348}
349