xref: /freebsd/sys/contrib/dev/acpica/components/executer/exstoren.c (revision b9f654b163bce26de79705e77b872427c9f2afa1)
1 /******************************************************************************
2  *
3  * Module Name: exstoren - AML Interpreter object store support,
4  *                        Store to Node (namespace object)
5  *
6  *****************************************************************************/
7 
8 /******************************************************************************
9  *
10  * 1. Copyright Notice
11  *
12  * Some or all of this work - Copyright (c) 1999 - 2019, 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  * Alternatively, you may choose to be licensed under the terms of the
118  * following license:
119  *
120  * Redistribution and use in source and binary forms, with or without
121  * modification, are permitted provided that the following conditions
122  * are met:
123  * 1. Redistributions of source code must retain the above copyright
124  *    notice, this list of conditions, and the following disclaimer,
125  *    without modification.
126  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
127  *    substantially similar to the "NO WARRANTY" disclaimer below
128  *    ("Disclaimer") and any redistribution must be conditioned upon
129  *    including a substantially similar Disclaimer requirement for further
130  *    binary redistribution.
131  * 3. Neither the names of the above-listed copyright holders nor the names
132  *    of any contributors may be used to endorse or promote products derived
133  *    from this software without specific prior written permission.
134  *
135  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
136  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
137  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
138  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
139  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
140  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
141  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
142  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
143  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
144  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
145  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
146  *
147  * Alternatively, you may choose to be licensed under the terms of the
148  * GNU General Public License ("GPL") version 2 as published by the Free
149  * Software Foundation.
150  *
151  *****************************************************************************/
152 
153 #include <contrib/dev/acpica/include/acpi.h>
154 #include <contrib/dev/acpica/include/accommon.h>
155 #include <contrib/dev/acpica/include/acinterp.h>
156 #include <contrib/dev/acpica/include/amlcode.h>
157 
158 
159 #define _COMPONENT          ACPI_EXECUTER
160         ACPI_MODULE_NAME    ("exstoren")
161 
162 
163 /*******************************************************************************
164  *
165  * FUNCTION:    AcpiExResolveObject
166  *
167  * PARAMETERS:  SourceDescPtr       - Pointer to the source object
168  *              TargetType          - Current type of the target
169  *              WalkState           - Current walk state
170  *
171  * RETURN:      Status, resolved object in SourceDescPtr.
172  *
173  * DESCRIPTION: Resolve an object. If the object is a reference, dereference
174  *              it and return the actual object in the SourceDescPtr.
175  *
176  ******************************************************************************/
177 
178 ACPI_STATUS
179 AcpiExResolveObject (
180     ACPI_OPERAND_OBJECT     **SourceDescPtr,
181     ACPI_OBJECT_TYPE        TargetType,
182     ACPI_WALK_STATE         *WalkState)
183 {
184     ACPI_OPERAND_OBJECT     *SourceDesc = *SourceDescPtr;
185     ACPI_STATUS             Status = AE_OK;
186 
187 
188     ACPI_FUNCTION_TRACE (ExResolveObject);
189 
190 
191     /* Ensure we have a Target that can be stored to */
192 
193     switch (TargetType)
194     {
195     case ACPI_TYPE_BUFFER_FIELD:
196     case ACPI_TYPE_LOCAL_REGION_FIELD:
197     case ACPI_TYPE_LOCAL_BANK_FIELD:
198     case ACPI_TYPE_LOCAL_INDEX_FIELD:
199         /*
200          * These cases all require only Integers or values that
201          * can be converted to Integers (Strings or Buffers)
202          */
203     case ACPI_TYPE_INTEGER:
204     case ACPI_TYPE_STRING:
205     case ACPI_TYPE_BUFFER:
206         /*
207          * Stores into a Field/Region or into a Integer/Buffer/String
208          * are all essentially the same. This case handles the
209          * "interchangeable" types Integer, String, and Buffer.
210          */
211         if (SourceDesc->Common.Type == ACPI_TYPE_LOCAL_REFERENCE)
212         {
213             /* Resolve a reference object first */
214 
215             Status = AcpiExResolveToValue (SourceDescPtr, WalkState);
216             if (ACPI_FAILURE (Status))
217             {
218                 break;
219             }
220         }
221 
222         /* For CopyObject, no further validation necessary */
223 
224         if (WalkState->Opcode == AML_COPY_OBJECT_OP)
225         {
226             break;
227         }
228 
229         /* Must have a Integer, Buffer, or String */
230 
231         if ((SourceDesc->Common.Type != ACPI_TYPE_INTEGER)    &&
232             (SourceDesc->Common.Type != ACPI_TYPE_BUFFER)     &&
233             (SourceDesc->Common.Type != ACPI_TYPE_STRING)     &&
234             !((SourceDesc->Common.Type == ACPI_TYPE_LOCAL_REFERENCE) &&
235                 (SourceDesc->Reference.Class== ACPI_REFCLASS_TABLE)))
236         {
237             /* Conversion successful but still not a valid type */
238 
239             ACPI_ERROR ((AE_INFO,
240                 "Cannot assign type [%s] to [%s] (must be type Int/Str/Buf)",
241                 AcpiUtGetObjectTypeName (SourceDesc),
242                 AcpiUtGetTypeName (TargetType)));
243 
244             Status = AE_AML_OPERAND_TYPE;
245         }
246         break;
247 
248     case ACPI_TYPE_LOCAL_ALIAS:
249     case ACPI_TYPE_LOCAL_METHOD_ALIAS:
250         /*
251          * All aliases should have been resolved earlier, during the
252          * operand resolution phase.
253          */
254         ACPI_ERROR ((AE_INFO, "Store into an unresolved Alias object"));
255         Status = AE_AML_INTERNAL;
256         break;
257 
258     case ACPI_TYPE_PACKAGE:
259     default:
260         /*
261          * All other types than Alias and the various Fields come here,
262          * including the untyped case - ACPI_TYPE_ANY.
263          */
264         break;
265     }
266 
267     return_ACPI_STATUS (Status);
268 }
269 
270 
271 /*******************************************************************************
272  *
273  * FUNCTION:    AcpiExStoreObjectToObject
274  *
275  * PARAMETERS:  SourceDesc          - Object to store
276  *              DestDesc            - Object to receive a copy of the source
277  *              NewDesc             - New object if DestDesc is obsoleted
278  *              WalkState           - Current walk state
279  *
280  * RETURN:      Status
281  *
282  * DESCRIPTION: "Store" an object to another object. This may include
283  *              converting the source type to the target type (implicit
284  *              conversion), and a copy of the value of the source to
285  *              the target.
286  *
287  *              The Assignment of an object to another (not named) object
288  *              is handled here.
289  *              The Source passed in will replace the current value (if any)
290  *              with the input value.
291  *
292  *              When storing into an object the data is converted to the
293  *              target object type then stored in the object. This means
294  *              that the target object type (for an initialized target) will
295  *              not be changed by a store operation.
296  *
297  *              This module allows destination types of Number, String,
298  *              Buffer, and Package.
299  *
300  *              Assumes parameters are already validated. NOTE: SourceDesc
301  *              resolution (from a reference object) must be performed by
302  *              the caller if necessary.
303  *
304  ******************************************************************************/
305 
306 ACPI_STATUS
307 AcpiExStoreObjectToObject (
308     ACPI_OPERAND_OBJECT     *SourceDesc,
309     ACPI_OPERAND_OBJECT     *DestDesc,
310     ACPI_OPERAND_OBJECT     **NewDesc,
311     ACPI_WALK_STATE         *WalkState)
312 {
313     ACPI_OPERAND_OBJECT     *ActualSrcDesc;
314     ACPI_STATUS             Status = AE_OK;
315 
316 
317     ACPI_FUNCTION_TRACE_PTR (ExStoreObjectToObject, SourceDesc);
318 
319 
320     ActualSrcDesc = SourceDesc;
321     if (!DestDesc)
322     {
323         /*
324          * There is no destination object (An uninitialized node or
325          * package element), so we can simply copy the source object
326          * creating a new destination object
327          */
328         Status = AcpiUtCopyIobjectToIobject (ActualSrcDesc, NewDesc, WalkState);
329         return_ACPI_STATUS (Status);
330     }
331 
332     if (SourceDesc->Common.Type != DestDesc->Common.Type)
333     {
334         /*
335          * The source type does not match the type of the destination.
336          * Perform the "implicit conversion" of the source to the current type
337          * of the target as per the ACPI specification.
338          *
339          * If no conversion performed, ActualSrcDesc = SourceDesc.
340          * Otherwise, ActualSrcDesc is a temporary object to hold the
341          * converted object.
342          */
343         Status = AcpiExConvertToTargetType (DestDesc->Common.Type,
344             SourceDesc, &ActualSrcDesc, WalkState);
345         if (ACPI_FAILURE (Status))
346         {
347             return_ACPI_STATUS (Status);
348         }
349 
350         if (SourceDesc == ActualSrcDesc)
351         {
352             /*
353              * No conversion was performed. Return the SourceDesc as the
354              * new object.
355              */
356             *NewDesc = SourceDesc;
357             return_ACPI_STATUS (AE_OK);
358         }
359     }
360 
361     /*
362      * We now have two objects of identical types, and we can perform a
363      * copy of the *value* of the source object.
364      */
365     switch (DestDesc->Common.Type)
366     {
367     case ACPI_TYPE_INTEGER:
368 
369         DestDesc->Integer.Value = ActualSrcDesc->Integer.Value;
370 
371         /* Truncate value if we are executing from a 32-bit ACPI table */
372 
373         (void) AcpiExTruncateFor32bitTable (DestDesc);
374         break;
375 
376     case ACPI_TYPE_STRING:
377 
378         Status = AcpiExStoreStringToString (ActualSrcDesc, DestDesc);
379         break;
380 
381     case ACPI_TYPE_BUFFER:
382 
383         Status = AcpiExStoreBufferToBuffer (ActualSrcDesc, DestDesc);
384         break;
385 
386     case ACPI_TYPE_PACKAGE:
387 
388         Status = AcpiUtCopyIobjectToIobject (ActualSrcDesc, &DestDesc,
389                     WalkState);
390         break;
391 
392     default:
393         /*
394          * All other types come here.
395          */
396         ACPI_WARNING ((AE_INFO, "Store into type [%s] not implemented",
397             AcpiUtGetObjectTypeName (DestDesc)));
398 
399         Status = AE_NOT_IMPLEMENTED;
400         break;
401     }
402 
403     if (ActualSrcDesc != SourceDesc)
404     {
405         /* Delete the intermediate (temporary) source object */
406 
407         AcpiUtRemoveReference (ActualSrcDesc);
408     }
409 
410     *NewDesc = DestDesc;
411     return_ACPI_STATUS (Status);
412 }
413