blob: 5442b32de61156a70a852e7a31d67360746d6b57 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/******************************************************************************
2 *
3 * Module Name: utcopy - Internal to external object translation utilities
4 *
5 *****************************************************************************/
6
7/*
8 * Copyright (C) 2000 - 2005, R. Byron Moore
9 * All rights reserved.
10 *
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions, and the following disclaimer,
16 * without modification.
17 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18 * substantially similar to the "NO WARRANTY" disclaimer below
19 * ("Disclaimer") and any redistribution must be conditioned upon
20 * including a substantially similar Disclaimer requirement for further
21 * binary redistribution.
22 * 3. Neither the names of the above-listed copyright holders nor the names
23 * of any contributors may be used to endorse or promote products derived
24 * from this software without specific prior written permission.
25 *
26 * Alternatively, this software may be distributed under the terms of the
27 * GNU General Public License ("GPL") version 2 as published by the Free
28 * Software Foundation.
29 *
30 * NO WARRANTY
31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41 * POSSIBILITY OF SUCH DAMAGES.
42 */
43
Linus Torvalds1da177e2005-04-16 15:20:36 -070044#include <acpi/acpi.h>
45#include <acpi/amlcode.h>
46
Linus Torvalds1da177e2005-04-16 15:20:36 -070047#define _COMPONENT ACPI_UTILITIES
Len Brown4be44fc2005-08-05 00:44:28 -040048ACPI_MODULE_NAME("utcopy")
Linus Torvalds1da177e2005-04-16 15:20:36 -070049
Robert Moore44f6c012005-04-18 22:49:35 -040050/* Local prototypes */
Len Brown4be44fc2005-08-05 00:44:28 -040051static acpi_status
52acpi_ut_copy_isimple_to_esimple(union acpi_operand_object *internal_object,
53 union acpi_object *external_object,
54 u8 * data_space, acpi_size * buffer_space_used);
Robert Moore44f6c012005-04-18 22:49:35 -040055
56static acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -040057acpi_ut_copy_ielement_to_ielement(u8 object_type,
58 union acpi_operand_object *source_object,
59 union acpi_generic_state *state,
60 void *context);
Robert Moore44f6c012005-04-18 22:49:35 -040061
62static acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -040063acpi_ut_copy_ipackage_to_epackage(union acpi_operand_object *internal_object,
64 u8 * buffer, acpi_size * space_used);
Robert Moore44f6c012005-04-18 22:49:35 -040065
66static acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -040067acpi_ut_copy_esimple_to_isimple(union acpi_object *user_obj,
68 union acpi_operand_object **return_obj);
Robert Moore44f6c012005-04-18 22:49:35 -040069
70static acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -040071acpi_ut_copy_simple_object(union acpi_operand_object *source_desc,
72 union acpi_operand_object *dest_desc);
Robert Moore44f6c012005-04-18 22:49:35 -040073
74static acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -040075acpi_ut_copy_ielement_to_eelement(u8 object_type,
76 union acpi_operand_object *source_object,
77 union acpi_generic_state *state,
78 void *context);
Robert Moore44f6c012005-04-18 22:49:35 -040079
80static acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -040081acpi_ut_copy_ipackage_to_ipackage(union acpi_operand_object *source_obj,
82 union acpi_operand_object *dest_obj,
83 struct acpi_walk_state *walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -070084
85/*******************************************************************************
86 *
87 * FUNCTION: acpi_ut_copy_isimple_to_esimple
88 *
Robert Moore44f6c012005-04-18 22:49:35 -040089 * PARAMETERS: internal_object - Source object to be copied
90 * external_object - Where to return the copied object
91 * data_space - Where object data is returned (such as
92 * buffer and string data)
93 * buffer_space_used - Length of data_space that was used
Linus Torvalds1da177e2005-04-16 15:20:36 -070094 *
95 * RETURN: Status
96 *
Robert Moore44f6c012005-04-18 22:49:35 -040097 * DESCRIPTION: This function is called to copy a simple internal object to
98 * an external object.
Linus Torvalds1da177e2005-04-16 15:20:36 -070099 *
Robert Moore44f6c012005-04-18 22:49:35 -0400100 * The data_space buffer is assumed to have sufficient space for
101 * the object.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102 *
103 ******************************************************************************/
104
105static acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400106acpi_ut_copy_isimple_to_esimple(union acpi_operand_object *internal_object,
107 union acpi_object *external_object,
108 u8 * data_space, acpi_size * buffer_space_used)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109{
Len Brown4be44fc2005-08-05 00:44:28 -0400110 acpi_status status = AE_OK;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111
Len Brown4be44fc2005-08-05 00:44:28 -0400112 ACPI_FUNCTION_TRACE("ut_copy_isimple_to_esimple");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113
114 *buffer_space_used = 0;
115
116 /*
117 * Check for NULL object case (could be an uninitialized
118 * package element)
119 */
120 if (!internal_object) {
Len Brown4be44fc2005-08-05 00:44:28 -0400121 return_ACPI_STATUS(AE_OK);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122 }
123
124 /* Always clear the external object */
125
Len Brown4be44fc2005-08-05 00:44:28 -0400126 ACPI_MEMSET(external_object, 0, sizeof(union acpi_object));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127
128 /*
129 * In general, the external object will be the same type as
130 * the internal object
131 */
Len Brown4be44fc2005-08-05 00:44:28 -0400132 external_object->type = ACPI_GET_OBJECT_TYPE(internal_object);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133
134 /* However, only a limited number of external types are supported */
135
Len Brown4be44fc2005-08-05 00:44:28 -0400136 switch (ACPI_GET_OBJECT_TYPE(internal_object)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700137 case ACPI_TYPE_STRING:
138
Len Brown4be44fc2005-08-05 00:44:28 -0400139 external_object->string.pointer = (char *)data_space;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140 external_object->string.length = internal_object->string.length;
Len Brown4be44fc2005-08-05 00:44:28 -0400141 *buffer_space_used = ACPI_ROUND_UP_TO_NATIVE_WORD((acpi_size)
142 internal_object->
143 string.
144 length + 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145
Len Brown4be44fc2005-08-05 00:44:28 -0400146 ACPI_MEMCPY((void *)data_space,
147 (void *)internal_object->string.pointer,
148 (acpi_size) internal_object->string.length + 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700149 break;
150
Linus Torvalds1da177e2005-04-16 15:20:36 -0700151 case ACPI_TYPE_BUFFER:
152
153 external_object->buffer.pointer = data_space;
154 external_object->buffer.length = internal_object->buffer.length;
Len Brown4be44fc2005-08-05 00:44:28 -0400155 *buffer_space_used =
156 ACPI_ROUND_UP_TO_NATIVE_WORD(internal_object->string.
157 length);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158
Len Brown4be44fc2005-08-05 00:44:28 -0400159 ACPI_MEMCPY((void *)data_space,
160 (void *)internal_object->buffer.pointer,
161 internal_object->buffer.length);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162 break;
163
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164 case ACPI_TYPE_INTEGER:
165
166 external_object->integer.value = internal_object->integer.value;
167 break;
168
Linus Torvalds1da177e2005-04-16 15:20:36 -0700169 case ACPI_TYPE_LOCAL_REFERENCE:
170
171 /*
172 * This is an object reference. Attempt to dereference it.
173 */
174 switch (internal_object->reference.opcode) {
175 case AML_INT_NAMEPATH_OP:
176
177 /* For namepath, return the object handle ("reference") */
178
179 default:
180 /*
181 * Use the object type of "Any" to indicate a reference
182 * to object containing a handle to an ACPI named object.
183 */
184 external_object->type = ACPI_TYPE_ANY;
Len Brown4be44fc2005-08-05 00:44:28 -0400185 external_object->reference.handle =
186 internal_object->reference.node;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700187 break;
188 }
189 break;
190
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191 case ACPI_TYPE_PROCESSOR:
192
Len Brown4be44fc2005-08-05 00:44:28 -0400193 external_object->processor.proc_id =
194 internal_object->processor.proc_id;
195 external_object->processor.pblk_address =
196 internal_object->processor.address;
197 external_object->processor.pblk_length =
198 internal_object->processor.length;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700199 break;
200
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201 case ACPI_TYPE_POWER:
202
203 external_object->power_resource.system_level =
Len Brown4be44fc2005-08-05 00:44:28 -0400204 internal_object->power_resource.system_level;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700205
206 external_object->power_resource.resource_order =
Len Brown4be44fc2005-08-05 00:44:28 -0400207 internal_object->power_resource.resource_order;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700208 break;
209
Linus Torvalds1da177e2005-04-16 15:20:36 -0700210 default:
211 /*
212 * There is no corresponding external object type
213 */
Len Brown4be44fc2005-08-05 00:44:28 -0400214 return_ACPI_STATUS(AE_SUPPORT);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700215 }
216
Len Brown4be44fc2005-08-05 00:44:28 -0400217 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700218}
219
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220/*******************************************************************************
221 *
222 * FUNCTION: acpi_ut_copy_ielement_to_eelement
223 *
224 * PARAMETERS: acpi_pkg_callback
225 *
226 * RETURN: Status
227 *
228 * DESCRIPTION: Copy one package element to another package element
229 *
230 ******************************************************************************/
231
Robert Moore44f6c012005-04-18 22:49:35 -0400232static acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400233acpi_ut_copy_ielement_to_eelement(u8 object_type,
234 union acpi_operand_object *source_object,
235 union acpi_generic_state *state,
236 void *context)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700237{
Len Brown4be44fc2005-08-05 00:44:28 -0400238 acpi_status status = AE_OK;
239 struct acpi_pkg_info *info = (struct acpi_pkg_info *)context;
240 acpi_size object_space;
241 u32 this_index;
242 union acpi_object *target_object;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700243
Len Brown4be44fc2005-08-05 00:44:28 -0400244 ACPI_FUNCTION_ENTRY();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700245
Len Brown4be44fc2005-08-05 00:44:28 -0400246 this_index = state->pkg.index;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700247 target_object = (union acpi_object *)
Len Brown4be44fc2005-08-05 00:44:28 -0400248 &((union acpi_object *)(state->pkg.dest_object))->package.
249 elements[this_index];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700250
251 switch (object_type) {
252 case ACPI_COPY_TYPE_SIMPLE:
253
254 /*
255 * This is a simple or null object
256 */
Len Brown4be44fc2005-08-05 00:44:28 -0400257 status = acpi_ut_copy_isimple_to_esimple(source_object,
258 target_object,
259 info->free_space,
260 &object_space);
261 if (ACPI_FAILURE(status)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700262 return (status);
263 }
264 break;
265
Linus Torvalds1da177e2005-04-16 15:20:36 -0700266 case ACPI_COPY_TYPE_PACKAGE:
267
268 /*
269 * Build the package object
270 */
Len Brown4be44fc2005-08-05 00:44:28 -0400271 target_object->type = ACPI_TYPE_PACKAGE;
272 target_object->package.count = source_object->package.count;
Robert Moore44f6c012005-04-18 22:49:35 -0400273 target_object->package.elements =
Len Brown4be44fc2005-08-05 00:44:28 -0400274 ACPI_CAST_PTR(union acpi_object, info->free_space);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700275
276 /*
277 * Pass the new package object back to the package walk routine
278 */
279 state->pkg.this_target_obj = target_object;
280
281 /*
282 * Save space for the array of objects (Package elements)
283 * update the buffer length counter
284 */
Len Brown4be44fc2005-08-05 00:44:28 -0400285 object_space = ACPI_ROUND_UP_TO_NATIVE_WORD((acpi_size)
286 target_object->
287 package.count *
288 sizeof(union
289 acpi_object));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700290 break;
291
Linus Torvalds1da177e2005-04-16 15:20:36 -0700292 default:
293 return (AE_BAD_PARAMETER);
294 }
295
Len Brown4be44fc2005-08-05 00:44:28 -0400296 info->free_space += object_space;
297 info->length += object_space;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700298 return (status);
299}
300
Linus Torvalds1da177e2005-04-16 15:20:36 -0700301/*******************************************************************************
302 *
303 * FUNCTION: acpi_ut_copy_ipackage_to_epackage
304 *
Robert Moore44f6c012005-04-18 22:49:35 -0400305 * PARAMETERS: internal_object - Pointer to the object we are returning
306 * Buffer - Where the object is returned
307 * space_used - Where the object length is returned
Linus Torvalds1da177e2005-04-16 15:20:36 -0700308 *
309 * RETURN: Status
310 *
311 * DESCRIPTION: This function is called to place a package object in a user
312 * buffer. A package object by definition contains other objects.
313 *
314 * The buffer is assumed to have sufficient space for the object.
315 * The caller must have verified the buffer length needed using the
316 * acpi_ut_get_object_size function before calling this function.
317 *
318 ******************************************************************************/
319
320static acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400321acpi_ut_copy_ipackage_to_epackage(union acpi_operand_object *internal_object,
322 u8 * buffer, acpi_size * space_used)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700323{
Len Brown4be44fc2005-08-05 00:44:28 -0400324 union acpi_object *external_object;
325 acpi_status status;
326 struct acpi_pkg_info info;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700327
Len Brown4be44fc2005-08-05 00:44:28 -0400328 ACPI_FUNCTION_TRACE("ut_copy_ipackage_to_epackage");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700329
330 /*
331 * First package at head of the buffer
332 */
Len Brown4be44fc2005-08-05 00:44:28 -0400333 external_object = ACPI_CAST_PTR(union acpi_object, buffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700334
335 /*
336 * Free space begins right after the first package
337 */
Len Brown4be44fc2005-08-05 00:44:28 -0400338 info.length = ACPI_ROUND_UP_TO_NATIVE_WORD(sizeof(union acpi_object));
339 info.free_space =
340 buffer + ACPI_ROUND_UP_TO_NATIVE_WORD(sizeof(union acpi_object));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700341 info.object_space = 0;
342 info.num_packages = 1;
343
Len Brown4be44fc2005-08-05 00:44:28 -0400344 external_object->type = ACPI_GET_OBJECT_TYPE(internal_object);
345 external_object->package.count = internal_object->package.count;
346 external_object->package.elements = ACPI_CAST_PTR(union acpi_object,
347 info.free_space);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348
349 /*
350 * Leave room for an array of ACPI_OBJECTS in the buffer
351 * and move the free space past it
352 */
Len Brown4be44fc2005-08-05 00:44:28 -0400353 info.length += (acpi_size) external_object->package.count *
354 ACPI_ROUND_UP_TO_NATIVE_WORD(sizeof(union acpi_object));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700355 info.free_space += external_object->package.count *
Len Brown4be44fc2005-08-05 00:44:28 -0400356 ACPI_ROUND_UP_TO_NATIVE_WORD(sizeof(union acpi_object));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700357
Len Brown4be44fc2005-08-05 00:44:28 -0400358 status = acpi_ut_walk_package_tree(internal_object, external_object,
359 acpi_ut_copy_ielement_to_eelement,
360 &info);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700361
362 *space_used = info.length;
Len Brown4be44fc2005-08-05 00:44:28 -0400363 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364}
365
Linus Torvalds1da177e2005-04-16 15:20:36 -0700366/*******************************************************************************
367 *
368 * FUNCTION: acpi_ut_copy_iobject_to_eobject
369 *
Robert Moore44f6c012005-04-18 22:49:35 -0400370 * PARAMETERS: internal_object - The internal object to be converted
371 * buffer_ptr - Where the object is returned
Linus Torvalds1da177e2005-04-16 15:20:36 -0700372 *
373 * RETURN: Status
374 *
375 * DESCRIPTION: This function is called to build an API object to be returned to
376 * the caller.
377 *
378 ******************************************************************************/
379
380acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400381acpi_ut_copy_iobject_to_eobject(union acpi_operand_object *internal_object,
382 struct acpi_buffer *ret_buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700383{
Len Brown4be44fc2005-08-05 00:44:28 -0400384 acpi_status status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700385
Len Brown4be44fc2005-08-05 00:44:28 -0400386 ACPI_FUNCTION_TRACE("ut_copy_iobject_to_eobject");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387
Len Brown4be44fc2005-08-05 00:44:28 -0400388 if (ACPI_GET_OBJECT_TYPE(internal_object) == ACPI_TYPE_PACKAGE) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700389 /*
390 * Package object: Copy all subobjects (including
391 * nested packages)
392 */
Len Brown4be44fc2005-08-05 00:44:28 -0400393 status = acpi_ut_copy_ipackage_to_epackage(internal_object,
394 ret_buffer->pointer,
395 &ret_buffer->length);
396 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700397 /*
398 * Build a simple object (no nested objects)
399 */
Len Brown4be44fc2005-08-05 00:44:28 -0400400 status = acpi_ut_copy_isimple_to_esimple(internal_object,
401 (union acpi_object *)
402 ret_buffer->pointer,
403 ((u8 *) ret_buffer->
404 pointer +
405 ACPI_ROUND_UP_TO_NATIVE_WORD
406 (sizeof
407 (union
408 acpi_object))),
409 &ret_buffer->length);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700410 /*
411 * build simple does not include the object size in the length
412 * so we add it in here
413 */
Len Brown4be44fc2005-08-05 00:44:28 -0400414 ret_buffer->length += sizeof(union acpi_object);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700415 }
416
Len Brown4be44fc2005-08-05 00:44:28 -0400417 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700418}
419
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420/*******************************************************************************
421 *
422 * FUNCTION: acpi_ut_copy_esimple_to_isimple
423 *
Robert Moore44f6c012005-04-18 22:49:35 -0400424 * PARAMETERS: external_object - The external object to be converted
425 * ret_internal_object - Where the internal object is returned
Linus Torvalds1da177e2005-04-16 15:20:36 -0700426 *
427 * RETURN: Status
428 *
429 * DESCRIPTION: This function copies an external object to an internal one.
430 * NOTE: Pointers can be copied, we don't need to copy data.
431 * (The pointers have to be valid in our address space no matter
432 * what we do with them!)
433 *
434 ******************************************************************************/
435
Robert Moore44f6c012005-04-18 22:49:35 -0400436static acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400437acpi_ut_copy_esimple_to_isimple(union acpi_object *external_object,
438 union acpi_operand_object **ret_internal_object)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700439{
Len Brown4be44fc2005-08-05 00:44:28 -0400440 union acpi_operand_object *internal_object;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700441
Len Brown4be44fc2005-08-05 00:44:28 -0400442 ACPI_FUNCTION_TRACE("ut_copy_esimple_to_isimple");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700443
444 /*
445 * Simple types supported are: String, Buffer, Integer
446 */
447 switch (external_object->type) {
448 case ACPI_TYPE_STRING:
449 case ACPI_TYPE_BUFFER:
450 case ACPI_TYPE_INTEGER:
451
Len Brown4be44fc2005-08-05 00:44:28 -0400452 internal_object = acpi_ut_create_internal_object((u8)
453 external_object->
454 type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700455 if (!internal_object) {
Len Brown4be44fc2005-08-05 00:44:28 -0400456 return_ACPI_STATUS(AE_NO_MEMORY);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700457 }
458 break;
459
460 default:
461 /* All other types are not supported */
462
Len Brown4be44fc2005-08-05 00:44:28 -0400463 return_ACPI_STATUS(AE_SUPPORT);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700464 }
465
Linus Torvalds1da177e2005-04-16 15:20:36 -0700466 /* Must COPY string and buffer contents */
467
468 switch (external_object->type) {
469 case ACPI_TYPE_STRING:
470
471 internal_object->string.pointer =
Len Brown4be44fc2005-08-05 00:44:28 -0400472 ACPI_MEM_CALLOCATE((acpi_size) external_object->string.
473 length + 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700474 if (!internal_object->string.pointer) {
475 goto error_exit;
476 }
477
Len Brown4be44fc2005-08-05 00:44:28 -0400478 ACPI_MEMCPY(internal_object->string.pointer,
479 external_object->string.pointer,
480 external_object->string.length);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700481
482 internal_object->string.length = external_object->string.length;
483 break;
484
Linus Torvalds1da177e2005-04-16 15:20:36 -0700485 case ACPI_TYPE_BUFFER:
486
487 internal_object->buffer.pointer =
Len Brown4be44fc2005-08-05 00:44:28 -0400488 ACPI_MEM_CALLOCATE(external_object->buffer.length);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700489 if (!internal_object->buffer.pointer) {
490 goto error_exit;
491 }
492
Len Brown4be44fc2005-08-05 00:44:28 -0400493 ACPI_MEMCPY(internal_object->buffer.pointer,
494 external_object->buffer.pointer,
495 external_object->buffer.length);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700496
497 internal_object->buffer.length = external_object->buffer.length;
498 break;
499
Linus Torvalds1da177e2005-04-16 15:20:36 -0700500 case ACPI_TYPE_INTEGER:
501
Len Brown4be44fc2005-08-05 00:44:28 -0400502 internal_object->integer.value = external_object->integer.value;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700503 break;
504
505 default:
506 /* Other types can't get here */
507 break;
508 }
509
510 *ret_internal_object = internal_object;
Len Brown4be44fc2005-08-05 00:44:28 -0400511 return_ACPI_STATUS(AE_OK);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700512
Len Brown4be44fc2005-08-05 00:44:28 -0400513 error_exit:
514 acpi_ut_remove_reference(internal_object);
515 return_ACPI_STATUS(AE_NO_MEMORY);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700516}
517
Linus Torvalds1da177e2005-04-16 15:20:36 -0700518#ifdef ACPI_FUTURE_IMPLEMENTATION
Linus Torvalds1da177e2005-04-16 15:20:36 -0700519/* Code to convert packages that are parameters to control methods */
520
521/*******************************************************************************
522 *
523 * FUNCTION: acpi_ut_copy_epackage_to_ipackage
524 *
525 * PARAMETERS: *internal_object - Pointer to the object we are returning
526 * *Buffer - Where the object is returned
527 * *space_used - Where the length of the object is returned
528 *
529 * RETURN: Status
530 *
531 * DESCRIPTION: This function is called to place a package object in a user
532 * buffer. A package object by definition contains other objects.
533 *
534 * The buffer is assumed to have sufficient space for the object.
535 * The caller must have verified the buffer length needed using the
536 * acpi_ut_get_object_size function before calling this function.
537 *
538 ******************************************************************************/
539
540static acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400541acpi_ut_copy_epackage_to_ipackage(union acpi_operand_object *internal_object,
542 u8 * buffer, u32 * space_used)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700543{
Len Brown4be44fc2005-08-05 00:44:28 -0400544 u8 *free_space;
545 union acpi_object *external_object;
546 u32 length = 0;
547 u32 this_index;
548 u32 object_space = 0;
549 union acpi_operand_object *this_internal_obj;
550 union acpi_object *this_external_obj;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551
Len Brown4be44fc2005-08-05 00:44:28 -0400552 ACPI_FUNCTION_TRACE("ut_copy_epackage_to_ipackage");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700553
554 /*
555 * First package at head of the buffer
556 */
557 external_object = (union acpi_object *)buffer;
558
559 /*
560 * Free space begins right after the first package
561 */
562 free_space = buffer + sizeof(union acpi_object);
563
Len Brown4be44fc2005-08-05 00:44:28 -0400564 external_object->type = ACPI_GET_OBJECT_TYPE(internal_object);
565 external_object->package.count = internal_object->package.count;
566 external_object->package.elements = (union acpi_object *)free_space;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700567
568 /*
569 * Build an array of ACPI_OBJECTS in the buffer
570 * and move the free space past it
571 */
Len Brown4be44fc2005-08-05 00:44:28 -0400572 free_space +=
573 external_object->package.count * sizeof(union acpi_object);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700574
575 /* Call walk_package */
576
577}
578
Len Brown4be44fc2005-08-05 00:44:28 -0400579#endif /* Future implementation */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700580
581/*******************************************************************************
582 *
583 * FUNCTION: acpi_ut_copy_eobject_to_iobject
584 *
585 * PARAMETERS: *internal_object - The external object to be converted
586 * *buffer_ptr - Where the internal object is returned
587 *
588 * RETURN: Status - the status of the call
589 *
590 * DESCRIPTION: Converts an external object to an internal object.
591 *
592 ******************************************************************************/
593
594acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400595acpi_ut_copy_eobject_to_iobject(union acpi_object *external_object,
596 union acpi_operand_object **internal_object)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700597{
Len Brown4be44fc2005-08-05 00:44:28 -0400598 acpi_status status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700599
Len Brown4be44fc2005-08-05 00:44:28 -0400600 ACPI_FUNCTION_TRACE("ut_copy_eobject_to_iobject");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700601
602 if (external_object->type == ACPI_TYPE_PACKAGE) {
603 /*
604 * Packages as external input to control methods are not supported,
605 */
Len Brown4be44fc2005-08-05 00:44:28 -0400606 ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
607 "Packages as parameters not implemented!\n"));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700608
Len Brown4be44fc2005-08-05 00:44:28 -0400609 return_ACPI_STATUS(AE_NOT_IMPLEMENTED);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700610 }
611
612 else {
613 /*
614 * Build a simple object (no nested objects)
615 */
Len Brown4be44fc2005-08-05 00:44:28 -0400616 status =
617 acpi_ut_copy_esimple_to_isimple(external_object,
618 internal_object);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700619 }
620
Len Brown4be44fc2005-08-05 00:44:28 -0400621 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700622}
623
Linus Torvalds1da177e2005-04-16 15:20:36 -0700624/*******************************************************************************
625 *
626 * FUNCTION: acpi_ut_copy_simple_object
627 *
628 * PARAMETERS: source_desc - The internal object to be copied
629 * dest_desc - New target object
630 *
631 * RETURN: Status
632 *
633 * DESCRIPTION: Simple copy of one internal object to another. Reference count
634 * of the destination object is preserved.
635 *
636 ******************************************************************************/
637
Robert Moore44f6c012005-04-18 22:49:35 -0400638static acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400639acpi_ut_copy_simple_object(union acpi_operand_object *source_desc,
640 union acpi_operand_object *dest_desc)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700641{
Len Brown4be44fc2005-08-05 00:44:28 -0400642 u16 reference_count;
643 union acpi_operand_object *next_object;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700644
645 /* Save fields from destination that we don't want to overwrite */
646
647 reference_count = dest_desc->common.reference_count;
648 next_object = dest_desc->common.next_object;
649
Len Brown4be44fc2005-08-05 00:44:28 -0400650 /* Copy the entire source object over the destination object */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700651
Len Brown4be44fc2005-08-05 00:44:28 -0400652 ACPI_MEMCPY((char *)dest_desc, (char *)source_desc,
653 sizeof(union acpi_operand_object));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700654
655 /* Restore the saved fields */
656
657 dest_desc->common.reference_count = reference_count;
658 dest_desc->common.next_object = next_object;
659
Robert Moore6f42ccf2005-05-13 00:00:00 -0400660 /* New object is not static, regardless of source */
661
662 dest_desc->common.flags &= ~AOPOBJ_STATIC_POINTER;
663
Linus Torvalds1da177e2005-04-16 15:20:36 -0700664 /* Handle the objects with extra data */
665
Len Brown4be44fc2005-08-05 00:44:28 -0400666 switch (ACPI_GET_OBJECT_TYPE(dest_desc)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700667 case ACPI_TYPE_BUFFER:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700668 /*
669 * Allocate and copy the actual buffer if and only if:
670 * 1) There is a valid buffer pointer
Robert Moore6f42ccf2005-05-13 00:00:00 -0400671 * 2) The buffer has a length > 0
Linus Torvalds1da177e2005-04-16 15:20:36 -0700672 */
673 if ((source_desc->buffer.pointer) &&
Len Brown4be44fc2005-08-05 00:44:28 -0400674 (source_desc->buffer.length)) {
Robert Moore6f42ccf2005-05-13 00:00:00 -0400675 dest_desc->buffer.pointer =
Len Brown4be44fc2005-08-05 00:44:28 -0400676 ACPI_MEM_ALLOCATE(source_desc->buffer.length);
Robert Moore6f42ccf2005-05-13 00:00:00 -0400677 if (!dest_desc->buffer.pointer) {
678 return (AE_NO_MEMORY);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700679 }
Robert Moore6f42ccf2005-05-13 00:00:00 -0400680
681 /* Copy the actual buffer data */
682
Len Brown4be44fc2005-08-05 00:44:28 -0400683 ACPI_MEMCPY(dest_desc->buffer.pointer,
684 source_desc->buffer.pointer,
685 source_desc->buffer.length);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700686 }
687 break;
688
689 case ACPI_TYPE_STRING:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700690 /*
691 * Allocate and copy the actual string if and only if:
692 * 1) There is a valid string pointer
Robert Moore6f42ccf2005-05-13 00:00:00 -0400693 * (Pointer to a NULL string is allowed)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700694 */
Robert Moore6f42ccf2005-05-13 00:00:00 -0400695 if (source_desc->string.pointer) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700696 dest_desc->string.pointer =
Len Brown4be44fc2005-08-05 00:44:28 -0400697 ACPI_MEM_ALLOCATE((acpi_size) source_desc->string.
698 length + 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700699 if (!dest_desc->string.pointer) {
700 return (AE_NO_MEMORY);
701 }
702
Robert Moore6f42ccf2005-05-13 00:00:00 -0400703 /* Copy the actual string data */
704
Len Brown4be44fc2005-08-05 00:44:28 -0400705 ACPI_MEMCPY(dest_desc->string.pointer,
706 source_desc->string.pointer,
707 (acpi_size) source_desc->string.length + 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700708 }
709 break;
710
711 case ACPI_TYPE_LOCAL_REFERENCE:
712 /*
713 * We copied the reference object, so we now must add a reference
714 * to the object pointed to by the reference
715 */
Len Brown4be44fc2005-08-05 00:44:28 -0400716 acpi_ut_add_reference(source_desc->reference.object);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700717 break;
718
719 default:
720 /* Nothing to do for other simple objects */
721 break;
722 }
723
724 return (AE_OK);
725}
726
Linus Torvalds1da177e2005-04-16 15:20:36 -0700727/*******************************************************************************
728 *
729 * FUNCTION: acpi_ut_copy_ielement_to_ielement
730 *
731 * PARAMETERS: acpi_pkg_callback
732 *
733 * RETURN: Status
734 *
735 * DESCRIPTION: Copy one package element to another package element
736 *
737 ******************************************************************************/
738
Robert Moore44f6c012005-04-18 22:49:35 -0400739static acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400740acpi_ut_copy_ielement_to_ielement(u8 object_type,
741 union acpi_operand_object *source_object,
742 union acpi_generic_state *state,
743 void *context)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700744{
Len Brown4be44fc2005-08-05 00:44:28 -0400745 acpi_status status = AE_OK;
746 u32 this_index;
747 union acpi_operand_object **this_target_ptr;
748 union acpi_operand_object *target_object;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700749
Len Brown4be44fc2005-08-05 00:44:28 -0400750 ACPI_FUNCTION_ENTRY();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700751
Len Brown4be44fc2005-08-05 00:44:28 -0400752 this_index = state->pkg.index;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700753 this_target_ptr = (union acpi_operand_object **)
Len Brown4be44fc2005-08-05 00:44:28 -0400754 &state->pkg.dest_object->package.elements[this_index];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700755
756 switch (object_type) {
757 case ACPI_COPY_TYPE_SIMPLE:
758
759 /* A null source object indicates a (legal) null package element */
760
761 if (source_object) {
762 /*
763 * This is a simple object, just copy it
764 */
Len Brown4be44fc2005-08-05 00:44:28 -0400765 target_object =
766 acpi_ut_create_internal_object(ACPI_GET_OBJECT_TYPE
767 (source_object));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700768 if (!target_object) {
769 return (AE_NO_MEMORY);
770 }
771
Len Brown4be44fc2005-08-05 00:44:28 -0400772 status =
773 acpi_ut_copy_simple_object(source_object,
774 target_object);
775 if (ACPI_FAILURE(status)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700776 goto error_exit;
777 }
778
779 *this_target_ptr = target_object;
Len Brown4be44fc2005-08-05 00:44:28 -0400780 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700781 /* Pass through a null element */
782
783 *this_target_ptr = NULL;
784 }
785 break;
786
Linus Torvalds1da177e2005-04-16 15:20:36 -0700787 case ACPI_COPY_TYPE_PACKAGE:
788
789 /*
790 * This object is a package - go down another nesting level
791 * Create and build the package object
792 */
Len Brown4be44fc2005-08-05 00:44:28 -0400793 target_object =
794 acpi_ut_create_internal_object(ACPI_TYPE_PACKAGE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700795 if (!target_object) {
796 return (AE_NO_MEMORY);
797 }
798
799 target_object->package.count = source_object->package.count;
800 target_object->common.flags = source_object->common.flags;
801
802 /*
803 * Create the object array
804 */
805 target_object->package.elements =
Len Brown4be44fc2005-08-05 00:44:28 -0400806 ACPI_MEM_CALLOCATE(((acpi_size) source_object->package.
807 count + 1) * sizeof(void *));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700808 if (!target_object->package.elements) {
809 status = AE_NO_MEMORY;
810 goto error_exit;
811 }
812
813 /*
814 * Pass the new package object back to the package walk routine
815 */
816 state->pkg.this_target_obj = target_object;
817
818 /*
819 * Store the object pointer in the parent package object
820 */
821 *this_target_ptr = target_object;
822 break;
823
Linus Torvalds1da177e2005-04-16 15:20:36 -0700824 default:
825 return (AE_BAD_PARAMETER);
826 }
827
828 return (status);
829
Len Brown4be44fc2005-08-05 00:44:28 -0400830 error_exit:
831 acpi_ut_remove_reference(target_object);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700832 return (status);
833}
834
Linus Torvalds1da177e2005-04-16 15:20:36 -0700835/*******************************************************************************
836 *
837 * FUNCTION: acpi_ut_copy_ipackage_to_ipackage
838 *
839 * PARAMETERS: *source_obj - Pointer to the source package object
840 * *dest_obj - Where the internal object is returned
841 *
842 * RETURN: Status - the status of the call
843 *
844 * DESCRIPTION: This function is called to copy an internal package object
845 * into another internal package object.
846 *
847 ******************************************************************************/
848
Robert Moore44f6c012005-04-18 22:49:35 -0400849static acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400850acpi_ut_copy_ipackage_to_ipackage(union acpi_operand_object *source_obj,
851 union acpi_operand_object *dest_obj,
852 struct acpi_walk_state *walk_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700853{
Len Brown4be44fc2005-08-05 00:44:28 -0400854 acpi_status status = AE_OK;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700855
Len Brown4be44fc2005-08-05 00:44:28 -0400856 ACPI_FUNCTION_TRACE("ut_copy_ipackage_to_ipackage");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700857
Len Brown4be44fc2005-08-05 00:44:28 -0400858 dest_obj->common.type = ACPI_GET_OBJECT_TYPE(source_obj);
859 dest_obj->common.flags = source_obj->common.flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700860 dest_obj->package.count = source_obj->package.count;
861
862 /*
863 * Create the object array and walk the source package tree
864 */
Len Brown4be44fc2005-08-05 00:44:28 -0400865 dest_obj->package.elements = ACPI_MEM_CALLOCATE(((acpi_size)
866 source_obj->package.
867 count +
868 1) * sizeof(void *));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700869 if (!dest_obj->package.elements) {
Len Brown4be44fc2005-08-05 00:44:28 -0400870 ACPI_REPORT_ERROR(("aml_build_copy_internal_package_object: Package allocation failure\n"));
871 return_ACPI_STATUS(AE_NO_MEMORY);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700872 }
873
874 /*
875 * Copy the package element-by-element by walking the package "tree".
876 * This handles nested packages of arbitrary depth.
877 */
Len Brown4be44fc2005-08-05 00:44:28 -0400878 status = acpi_ut_walk_package_tree(source_obj, dest_obj,
879 acpi_ut_copy_ielement_to_ielement,
880 walk_state);
881 if (ACPI_FAILURE(status)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700882 /* On failure, delete the destination package object */
883
Len Brown4be44fc2005-08-05 00:44:28 -0400884 acpi_ut_remove_reference(dest_obj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700885 }
886
Len Brown4be44fc2005-08-05 00:44:28 -0400887 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700888}
889
Linus Torvalds1da177e2005-04-16 15:20:36 -0700890/*******************************************************************************
891 *
892 * FUNCTION: acpi_ut_copy_iobject_to_iobject
893 *
894 * PARAMETERS: walk_state - Current walk state
895 * source_desc - The internal object to be copied
896 * dest_desc - Where the copied object is returned
897 *
898 * RETURN: Status
899 *
900 * DESCRIPTION: Copy an internal object to a new internal object
901 *
902 ******************************************************************************/
903
904acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400905acpi_ut_copy_iobject_to_iobject(union acpi_operand_object *source_desc,
906 union acpi_operand_object **dest_desc,
907 struct acpi_walk_state *walk_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700908{
Len Brown4be44fc2005-08-05 00:44:28 -0400909 acpi_status status = AE_OK;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700910
Len Brown4be44fc2005-08-05 00:44:28 -0400911 ACPI_FUNCTION_TRACE("ut_copy_iobject_to_iobject");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700912
913 /* Create the top level object */
914
Len Brown4be44fc2005-08-05 00:44:28 -0400915 *dest_desc =
916 acpi_ut_create_internal_object(ACPI_GET_OBJECT_TYPE(source_desc));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700917 if (!*dest_desc) {
Len Brown4be44fc2005-08-05 00:44:28 -0400918 return_ACPI_STATUS(AE_NO_MEMORY);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700919 }
920
921 /* Copy the object and possible subobjects */
922
Len Brown4be44fc2005-08-05 00:44:28 -0400923 if (ACPI_GET_OBJECT_TYPE(source_desc) == ACPI_TYPE_PACKAGE) {
924 status =
925 acpi_ut_copy_ipackage_to_ipackage(source_desc, *dest_desc,
926 walk_state);
927 } else {
928 status = acpi_ut_copy_simple_object(source_desc, *dest_desc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700929 }
930
Len Brown4be44fc2005-08-05 00:44:28 -0400931 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700932}