Pull xpc-disengage into release branch
[linux-2.6] / drivers / acpi / executer / exstoren.c
1
2 /******************************************************************************
3  *
4  * Module Name: exstoren - AML Interpreter object store support,
5  *                        Store to Node (namespace object)
6  *
7  *****************************************************************************/
8
9 /*
10  * Copyright (C) 2000 - 2005, R. Byron Moore
11  * All rights reserved.
12  *
13  * Redistribution and use in source and binary forms, with or without
14  * modification, are permitted provided that the following conditions
15  * are met:
16  * 1. Redistributions of source code must retain the above copyright
17  *    notice, this list of conditions, and the following disclaimer,
18  *    without modification.
19  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
20  *    substantially similar to the "NO WARRANTY" disclaimer below
21  *    ("Disclaimer") and any redistribution must be conditioned upon
22  *    including a substantially similar Disclaimer requirement for further
23  *    binary redistribution.
24  * 3. Neither the names of the above-listed copyright holders nor the names
25  *    of any contributors may be used to endorse or promote products derived
26  *    from this software without specific prior written permission.
27  *
28  * Alternatively, this software may be distributed under the terms of the
29  * GNU General Public License ("GPL") version 2 as published by the Free
30  * Software Foundation.
31  *
32  * NO WARRANTY
33  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
34  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
35  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
36  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
37  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
38  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
39  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
40  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
41  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
42  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
43  * POSSIBILITY OF SUCH DAMAGES.
44  */
45
46 #include <acpi/acpi.h>
47 #include <acpi/acinterp.h>
48 #include <acpi/amlcode.h>
49
50 #define _COMPONENT          ACPI_EXECUTER
51 ACPI_MODULE_NAME("exstoren")
52
53 /*******************************************************************************
54  *
55  * FUNCTION:    acpi_ex_resolve_object
56  *
57  * PARAMETERS:  source_desc_ptr     - Pointer to the source object
58  *              target_type         - Current type of the target
59  *              walk_state          - Current walk state
60  *
61  * RETURN:      Status, resolved object in source_desc_ptr.
62  *
63  * DESCRIPTION: Resolve an object.  If the object is a reference, dereference
64  *              it and return the actual object in the source_desc_ptr.
65  *
66  ******************************************************************************/
67 acpi_status
68 acpi_ex_resolve_object(union acpi_operand_object **source_desc_ptr,
69                        acpi_object_type target_type,
70                        struct acpi_walk_state *walk_state)
71 {
72         union acpi_operand_object *source_desc = *source_desc_ptr;
73         acpi_status status = AE_OK;
74
75         ACPI_FUNCTION_TRACE("ex_resolve_object");
76
77         /* Ensure we have a Target that can be stored to */
78
79         switch (target_type) {
80         case ACPI_TYPE_BUFFER_FIELD:
81         case ACPI_TYPE_LOCAL_REGION_FIELD:
82         case ACPI_TYPE_LOCAL_BANK_FIELD:
83         case ACPI_TYPE_LOCAL_INDEX_FIELD:
84                 /*
85                  * These cases all require only Integers or values that
86                  * can be converted to Integers (Strings or Buffers)
87                  */
88
89         case ACPI_TYPE_INTEGER:
90         case ACPI_TYPE_STRING:
91         case ACPI_TYPE_BUFFER:
92
93                 /*
94                  * Stores into a Field/Region or into a Integer/Buffer/String
95                  * are all essentially the same.  This case handles the
96                  * "interchangeable" types Integer, String, and Buffer.
97                  */
98                 if (ACPI_GET_OBJECT_TYPE(source_desc) ==
99                     ACPI_TYPE_LOCAL_REFERENCE) {
100                         /* Resolve a reference object first */
101
102                         status =
103                             acpi_ex_resolve_to_value(source_desc_ptr,
104                                                      walk_state);
105                         if (ACPI_FAILURE(status)) {
106                                 break;
107                         }
108                 }
109
110                 /* For copy_object, no further validation necessary */
111
112                 if (walk_state->opcode == AML_COPY_OP) {
113                         break;
114                 }
115
116                 /* Must have a Integer, Buffer, or String */
117
118                 if ((ACPI_GET_OBJECT_TYPE(source_desc) != ACPI_TYPE_INTEGER) &&
119                     (ACPI_GET_OBJECT_TYPE(source_desc) != ACPI_TYPE_BUFFER) &&
120                     (ACPI_GET_OBJECT_TYPE(source_desc) != ACPI_TYPE_STRING) &&
121                     !((ACPI_GET_OBJECT_TYPE(source_desc) ==
122                        ACPI_TYPE_LOCAL_REFERENCE)
123                       && (source_desc->reference.opcode == AML_LOAD_OP))) {
124                         /* Conversion successful but still not a valid type */
125
126                         ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
127                                           "Cannot assign type %s to %s (must be type Int/Str/Buf)\n",
128                                           acpi_ut_get_object_type_name
129                                           (source_desc),
130                                           acpi_ut_get_type_name(target_type)));
131                         status = AE_AML_OPERAND_TYPE;
132                 }
133                 break;
134
135         case ACPI_TYPE_LOCAL_ALIAS:
136         case ACPI_TYPE_LOCAL_METHOD_ALIAS:
137
138                 /* Aliases are resolved by acpi_ex_prep_operands */
139
140                 ACPI_REPORT_ERROR(("Store into Alias - should never happen\n"));
141                 status = AE_AML_INTERNAL;
142                 break;
143
144         case ACPI_TYPE_PACKAGE:
145         default:
146
147                 /*
148                  * All other types than Alias and the various Fields come here,
149                  * including the untyped case - ACPI_TYPE_ANY.
150                  */
151                 break;
152         }
153
154         return_ACPI_STATUS(status);
155 }
156
157 /*******************************************************************************
158  *
159  * FUNCTION:    acpi_ex_store_object_to_object
160  *
161  * PARAMETERS:  source_desc         - Object to store
162  *              dest_desc           - Object to receive a copy of the source
163  *              new_desc            - New object if dest_desc is obsoleted
164  *              walk_state          - Current walk state
165  *
166  * RETURN:      Status
167  *
168  * DESCRIPTION: "Store" an object to another object.  This may include
169  *              converting the source type to the target type (implicit
170  *              conversion), and a copy of the value of the source to
171  *              the target.
172  *
173  *              The Assignment of an object to another (not named) object
174  *              is handled here.
175  *              The Source passed in will replace the current value (if any)
176  *              with the input value.
177  *
178  *              When storing into an object the data is converted to the
179  *              target object type then stored in the object.  This means
180  *              that the target object type (for an initialized target) will
181  *              not be changed by a store operation.
182  *
183  *              This module allows destination types of Number, String,
184  *              Buffer, and Package.
185  *
186  *              Assumes parameters are already validated.  NOTE: source_desc
187  *              resolution (from a reference object) must be performed by
188  *              the caller if necessary.
189  *
190  ******************************************************************************/
191
192 acpi_status
193 acpi_ex_store_object_to_object(union acpi_operand_object *source_desc,
194                                union acpi_operand_object *dest_desc,
195                                union acpi_operand_object **new_desc,
196                                struct acpi_walk_state *walk_state)
197 {
198         union acpi_operand_object *actual_src_desc;
199         acpi_status status = AE_OK;
200
201         ACPI_FUNCTION_TRACE_PTR("ex_store_object_to_object", source_desc);
202
203         actual_src_desc = source_desc;
204         if (!dest_desc) {
205                 /*
206                  * There is no destination object (An uninitialized node or
207                  * package element), so we can simply copy the source object
208                  * creating a new destination object
209                  */
210                 status =
211                     acpi_ut_copy_iobject_to_iobject(actual_src_desc, new_desc,
212                                                     walk_state);
213                 return_ACPI_STATUS(status);
214         }
215
216         if (ACPI_GET_OBJECT_TYPE(source_desc) !=
217             ACPI_GET_OBJECT_TYPE(dest_desc)) {
218                 /*
219                  * The source type does not match the type of the destination.
220                  * Perform the "implicit conversion" of the source to the current type
221                  * of the target as per the ACPI specification.
222                  *
223                  * If no conversion performed, actual_src_desc = source_desc.
224                  * Otherwise, actual_src_desc is a temporary object to hold the
225                  * converted object.
226                  */
227                 status =
228                     acpi_ex_convert_to_target_type(ACPI_GET_OBJECT_TYPE
229                                                    (dest_desc), source_desc,
230                                                    &actual_src_desc,
231                                                    walk_state);
232                 if (ACPI_FAILURE(status)) {
233                         return_ACPI_STATUS(status);
234                 }
235
236                 if (source_desc == actual_src_desc) {
237                         /*
238                          * No conversion was performed. Return the source_desc as the
239                          * new object.
240                          */
241                         *new_desc = source_desc;
242                         return_ACPI_STATUS(AE_OK);
243                 }
244         }
245
246         /*
247          * We now have two objects of identical types, and we can perform a
248          * copy of the *value* of the source object.
249          */
250         switch (ACPI_GET_OBJECT_TYPE(dest_desc)) {
251         case ACPI_TYPE_INTEGER:
252
253                 dest_desc->integer.value = actual_src_desc->integer.value;
254
255                 /* Truncate value if we are executing from a 32-bit ACPI table */
256
257                 acpi_ex_truncate_for32bit_table(dest_desc);
258                 break;
259
260         case ACPI_TYPE_STRING:
261
262                 status =
263                     acpi_ex_store_string_to_string(actual_src_desc, dest_desc);
264                 break;
265
266         case ACPI_TYPE_BUFFER:
267
268                 status =
269                     acpi_ex_store_buffer_to_buffer(actual_src_desc, dest_desc);
270                 break;
271
272         case ACPI_TYPE_PACKAGE:
273
274                 status =
275                     acpi_ut_copy_iobject_to_iobject(actual_src_desc, &dest_desc,
276                                                     walk_state);
277                 break;
278
279         default:
280                 /*
281                  * All other types come here.
282                  */
283                 ACPI_DEBUG_PRINT((ACPI_DB_WARN,
284                                   "Store into type %s not implemented\n",
285                                   acpi_ut_get_object_type_name(dest_desc)));
286
287                 status = AE_NOT_IMPLEMENTED;
288                 break;
289         }
290
291         if (actual_src_desc != source_desc) {
292                 /* Delete the intermediate (temporary) source object */
293
294                 acpi_ut_remove_reference(actual_src_desc);
295         }
296
297         *new_desc = dest_desc;
298         return_ACPI_STATUS(status);
299 }