Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /****************************************************************************** |
2 | * | |
3 | * Module Name: utobject - ACPI object create/delete/size/cache routines | |
4 | * | |
5 | *****************************************************************************/ | |
6 | ||
7 | /* | |
82a80941 | 8 | * Copyright (C) 2000 - 2015, Intel Corp. |
1da177e4 LT |
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 | ||
1da177e4 | 44 | #include <acpi/acpi.h> |
e2f7a777 LB |
45 | #include "accommon.h" |
46 | #include "acnamesp.h" | |
1da177e4 | 47 | |
1da177e4 | 48 | #define _COMPONENT ACPI_UTILITIES |
4be44fcd | 49 | ACPI_MODULE_NAME("utobject") |
1da177e4 | 50 | |
44f6c012 | 51 | /* Local prototypes */ |
44f6c012 | 52 | static acpi_status |
4be44fcd LB |
53 | acpi_ut_get_simple_object_size(union acpi_operand_object *obj, |
54 | acpi_size * obj_length); | |
44f6c012 RM |
55 | |
56 | static acpi_status | |
4be44fcd LB |
57 | acpi_ut_get_package_object_size(union acpi_operand_object *obj, |
58 | acpi_size * obj_length); | |
44f6c012 RM |
59 | |
60 | static acpi_status | |
4be44fcd LB |
61 | acpi_ut_get_element_length(u8 object_type, |
62 | union acpi_operand_object *source_object, | |
63 | union acpi_generic_state *state, void *context); | |
1da177e4 LT |
64 | |
65 | /******************************************************************************* | |
66 | * | |
67 | * FUNCTION: acpi_ut_create_internal_object_dbg | |
68 | * | |
69 | * PARAMETERS: module_name - Source file name of caller | |
70 | * line_number - Line number of caller | |
71 | * component_id - Component type of caller | |
ba494bee | 72 | * type - ACPI Type of the new object |
1da177e4 | 73 | * |
44f6c012 | 74 | * RETURN: A new internal object, null on failure |
1da177e4 LT |
75 | * |
76 | * DESCRIPTION: Create and initialize a new internal object. | |
77 | * | |
78 | * NOTE: We always allocate the worst-case object descriptor because | |
79 | * these objects are cached, and we want them to be | |
73a3090a | 80 | * one-size-satisifies-any-request. This in itself may not be |
1da177e4 LT |
81 | * the most memory efficient, but the efficiency of the object |
82 | * cache should more than make up for this! | |
83 | * | |
84 | ******************************************************************************/ | |
85 | ||
4b8ed631 BM |
86 | union acpi_operand_object *acpi_ut_create_internal_object_dbg(const char |
87 | *module_name, | |
4be44fcd LB |
88 | u32 line_number, |
89 | u32 component_id, | |
90 | acpi_object_type | |
91 | type) | |
1da177e4 | 92 | { |
4be44fcd LB |
93 | union acpi_operand_object *object; |
94 | union acpi_operand_object *second_object; | |
1da177e4 | 95 | |
b229cf92 | 96 | ACPI_FUNCTION_TRACE_STR(ut_create_internal_object_dbg, |
4be44fcd | 97 | acpi_ut_get_type_name(type)); |
1da177e4 LT |
98 | |
99 | /* Allocate the raw object descriptor */ | |
100 | ||
4be44fcd LB |
101 | object = |
102 | acpi_ut_allocate_object_desc_dbg(module_name, line_number, | |
103 | component_id); | |
1da177e4 | 104 | if (!object) { |
4be44fcd | 105 | return_PTR(NULL); |
1da177e4 LT |
106 | } |
107 | ||
108 | switch (type) { | |
109 | case ACPI_TYPE_REGION: | |
110 | case ACPI_TYPE_BUFFER_FIELD: | |
ef805d95 | 111 | case ACPI_TYPE_LOCAL_BANK_FIELD: |
1da177e4 LT |
112 | |
113 | /* These types require a secondary object */ | |
114 | ||
4be44fcd LB |
115 | second_object = acpi_ut_allocate_object_desc_dbg(module_name, |
116 | line_number, | |
117 | component_id); | |
1da177e4 | 118 | if (!second_object) { |
4be44fcd LB |
119 | acpi_ut_delete_object_desc(object); |
120 | return_PTR(NULL); | |
1da177e4 LT |
121 | } |
122 | ||
123 | second_object->common.type = ACPI_TYPE_LOCAL_EXTRA; | |
124 | second_object->common.reference_count = 1; | |
125 | ||
126 | /* Link the second object to the first */ | |
127 | ||
128 | object->common.next_object = second_object; | |
129 | break; | |
130 | ||
131 | default: | |
1d1ea1b7 | 132 | |
1da177e4 LT |
133 | /* All others have no secondary object */ |
134 | break; | |
135 | } | |
136 | ||
137 | /* Save the object type in the object descriptor */ | |
138 | ||
139 | object->common.type = (u8) type; | |
140 | ||
141 | /* Init the reference count */ | |
142 | ||
143 | object->common.reference_count = 1; | |
144 | ||
145 | /* Any per-type initialization should go here */ | |
146 | ||
4be44fcd | 147 | return_PTR(object); |
1da177e4 LT |
148 | } |
149 | ||
6287ee32 BM |
150 | /******************************************************************************* |
151 | * | |
152 | * FUNCTION: acpi_ut_create_package_object | |
153 | * | |
ba494bee | 154 | * PARAMETERS: count - Number of package elements |
6287ee32 BM |
155 | * |
156 | * RETURN: Pointer to a new Package object, null on failure | |
157 | * | |
158 | * DESCRIPTION: Create a fully initialized package object | |
159 | * | |
160 | ******************************************************************************/ | |
161 | ||
162 | union acpi_operand_object *acpi_ut_create_package_object(u32 count) | |
163 | { | |
164 | union acpi_operand_object *package_desc; | |
165 | union acpi_operand_object **package_elements; | |
166 | ||
167 | ACPI_FUNCTION_TRACE_U32(ut_create_package_object, count); | |
168 | ||
169 | /* Create a new Package object */ | |
170 | ||
171 | package_desc = acpi_ut_create_internal_object(ACPI_TYPE_PACKAGE); | |
172 | if (!package_desc) { | |
173 | return_PTR(NULL); | |
174 | } | |
175 | ||
176 | /* | |
177 | * Create the element array. Count+1 allows the array to be null | |
178 | * terminated. | |
179 | */ | |
67a119f9 BM |
180 | package_elements = ACPI_ALLOCATE_ZEROED(((acpi_size) count + |
181 | 1) * sizeof(void *)); | |
6287ee32 | 182 | if (!package_elements) { |
bd48d677 | 183 | ACPI_FREE(package_desc); |
6287ee32 BM |
184 | return_PTR(NULL); |
185 | } | |
186 | ||
187 | package_desc->package.count = count; | |
188 | package_desc->package.elements = package_elements; | |
189 | return_PTR(package_desc); | |
190 | } | |
191 | ||
502f7efa BM |
192 | /******************************************************************************* |
193 | * | |
194 | * FUNCTION: acpi_ut_create_integer_object | |
195 | * | |
196 | * PARAMETERS: initial_value - Initial value for the integer | |
197 | * | |
198 | * RETURN: Pointer to a new Integer object, null on failure | |
199 | * | |
200 | * DESCRIPTION: Create an initialized integer object | |
201 | * | |
202 | ******************************************************************************/ | |
203 | ||
204 | union acpi_operand_object *acpi_ut_create_integer_object(u64 initial_value) | |
205 | { | |
206 | union acpi_operand_object *integer_desc; | |
207 | ||
208 | ACPI_FUNCTION_TRACE(ut_create_integer_object); | |
209 | ||
210 | /* Create and initialize a new integer object */ | |
211 | ||
212 | integer_desc = acpi_ut_create_internal_object(ACPI_TYPE_INTEGER); | |
213 | if (!integer_desc) { | |
214 | return_PTR(NULL); | |
215 | } | |
216 | ||
217 | integer_desc->integer.value = initial_value; | |
218 | return_PTR(integer_desc); | |
219 | } | |
220 | ||
1da177e4 LT |
221 | /******************************************************************************* |
222 | * | |
223 | * FUNCTION: acpi_ut_create_buffer_object | |
224 | * | |
225 | * PARAMETERS: buffer_size - Size of buffer to be created | |
226 | * | |
44f6c012 | 227 | * RETURN: Pointer to a new Buffer object, null on failure |
1da177e4 LT |
228 | * |
229 | * DESCRIPTION: Create a fully initialized buffer object | |
230 | * | |
231 | ******************************************************************************/ | |
232 | ||
4be44fcd | 233 | union acpi_operand_object *acpi_ut_create_buffer_object(acpi_size buffer_size) |
1da177e4 | 234 | { |
4be44fcd LB |
235 | union acpi_operand_object *buffer_desc; |
236 | u8 *buffer = NULL; | |
1da177e4 | 237 | |
b229cf92 | 238 | ACPI_FUNCTION_TRACE_U32(ut_create_buffer_object, buffer_size); |
1da177e4 LT |
239 | |
240 | /* Create a new Buffer object */ | |
241 | ||
4be44fcd | 242 | buffer_desc = acpi_ut_create_internal_object(ACPI_TYPE_BUFFER); |
1da177e4 | 243 | if (!buffer_desc) { |
4be44fcd | 244 | return_PTR(NULL); |
1da177e4 LT |
245 | } |
246 | ||
247 | /* Create an actual buffer only if size > 0 */ | |
248 | ||
249 | if (buffer_size > 0) { | |
52fc0b02 | 250 | |
1da177e4 LT |
251 | /* Allocate the actual buffer */ |
252 | ||
8313524a | 253 | buffer = ACPI_ALLOCATE_ZEROED(buffer_size); |
1da177e4 | 254 | if (!buffer) { |
f6a22b0b | 255 | ACPI_ERROR((AE_INFO, "Could not allocate size %u", |
b8e4d893 | 256 | (u32) buffer_size)); |
4be44fcd LB |
257 | acpi_ut_remove_reference(buffer_desc); |
258 | return_PTR(NULL); | |
1da177e4 LT |
259 | } |
260 | } | |
261 | ||
262 | /* Complete buffer object initialization */ | |
263 | ||
264 | buffer_desc->buffer.flags |= AOPOBJ_DATA_VALID; | |
265 | buffer_desc->buffer.pointer = buffer; | |
266 | buffer_desc->buffer.length = (u32) buffer_size; | |
267 | ||
268 | /* Return the new buffer descriptor */ | |
269 | ||
4be44fcd | 270 | return_PTR(buffer_desc); |
1da177e4 LT |
271 | } |
272 | ||
1da177e4 LT |
273 | /******************************************************************************* |
274 | * | |
275 | * FUNCTION: acpi_ut_create_string_object | |
276 | * | |
44f6c012 RM |
277 | * PARAMETERS: string_size - Size of string to be created. Does not |
278 | * include NULL terminator, this is added | |
279 | * automatically. | |
1da177e4 LT |
280 | * |
281 | * RETURN: Pointer to a new String object | |
282 | * | |
283 | * DESCRIPTION: Create a fully initialized string object | |
284 | * | |
285 | ******************************************************************************/ | |
286 | ||
4be44fcd | 287 | union acpi_operand_object *acpi_ut_create_string_object(acpi_size string_size) |
1da177e4 | 288 | { |
4be44fcd LB |
289 | union acpi_operand_object *string_desc; |
290 | char *string; | |
1da177e4 | 291 | |
b229cf92 | 292 | ACPI_FUNCTION_TRACE_U32(ut_create_string_object, string_size); |
1da177e4 LT |
293 | |
294 | /* Create a new String object */ | |
295 | ||
4be44fcd | 296 | string_desc = acpi_ut_create_internal_object(ACPI_TYPE_STRING); |
1da177e4 | 297 | if (!string_desc) { |
4be44fcd | 298 | return_PTR(NULL); |
1da177e4 LT |
299 | } |
300 | ||
301 | /* | |
302 | * Allocate the actual string buffer -- (Size + 1) for NULL terminator. | |
303 | * NOTE: Zero-length strings are NULL terminated | |
304 | */ | |
8313524a | 305 | string = ACPI_ALLOCATE_ZEROED(string_size + 1); |
1da177e4 | 306 | if (!string) { |
f6a22b0b | 307 | ACPI_ERROR((AE_INFO, "Could not allocate size %u", |
b8e4d893 | 308 | (u32) string_size)); |
4be44fcd LB |
309 | acpi_ut_remove_reference(string_desc); |
310 | return_PTR(NULL); | |
1da177e4 LT |
311 | } |
312 | ||
313 | /* Complete string object initialization */ | |
314 | ||
315 | string_desc->string.pointer = string; | |
316 | string_desc->string.length = (u32) string_size; | |
317 | ||
318 | /* Return the new string descriptor */ | |
319 | ||
4be44fcd | 320 | return_PTR(string_desc); |
1da177e4 LT |
321 | } |
322 | ||
1da177e4 LT |
323 | /******************************************************************************* |
324 | * | |
325 | * FUNCTION: acpi_ut_valid_internal_object | |
326 | * | |
ba494bee | 327 | * PARAMETERS: object - Object to be validated |
1da177e4 | 328 | * |
44f6c012 RM |
329 | * RETURN: TRUE if object is valid, FALSE otherwise |
330 | * | |
cf48958e | 331 | * DESCRIPTION: Validate a pointer to be of type union acpi_operand_object |
1da177e4 LT |
332 | * |
333 | ******************************************************************************/ | |
334 | ||
4be44fcd | 335 | u8 acpi_ut_valid_internal_object(void *object) |
1da177e4 LT |
336 | { |
337 | ||
b229cf92 | 338 | ACPI_FUNCTION_NAME(ut_valid_internal_object); |
1da177e4 LT |
339 | |
340 | /* Check for a null pointer */ | |
341 | ||
342 | if (!object) { | |
7bcc06e8 | 343 | ACPI_DEBUG_PRINT((ACPI_DB_EXEC, "**** Null Object Ptr\n")); |
1da177e4 LT |
344 | return (FALSE); |
345 | } | |
346 | ||
347 | /* Check the descriptor type field */ | |
348 | ||
4be44fcd | 349 | switch (ACPI_GET_DESCRIPTOR_TYPE(object)) { |
1da177e4 LT |
350 | case ACPI_DESC_TYPE_OPERAND: |
351 | ||
cf48958e | 352 | /* The object appears to be a valid union acpi_operand_object */ |
1da177e4 LT |
353 | |
354 | return (TRUE); | |
355 | ||
356 | default: | |
1d1ea1b7 | 357 | |
7bcc06e8 | 358 | ACPI_DEBUG_PRINT((ACPI_DB_EXEC, |
6d3be300 | 359 | "%p is not an ACPI operand obj [%s]\n", |
4be44fcd | 360 | object, acpi_ut_get_descriptor_name(object))); |
1da177e4 LT |
361 | break; |
362 | } | |
363 | ||
364 | return (FALSE); | |
365 | } | |
366 | ||
1da177e4 LT |
367 | /******************************************************************************* |
368 | * | |
369 | * FUNCTION: acpi_ut_allocate_object_desc_dbg | |
370 | * | |
371 | * PARAMETERS: module_name - Caller's module name (for error output) | |
372 | * line_number - Caller's line number (for error output) | |
373 | * component_id - Caller's component ID (for error output) | |
374 | * | |
73a3090a | 375 | * RETURN: Pointer to newly allocated object descriptor. Null on error |
1da177e4 | 376 | * |
73a3090a | 377 | * DESCRIPTION: Allocate a new object descriptor. Gracefully handle |
1da177e4 LT |
378 | * error conditions. |
379 | * | |
380 | ******************************************************************************/ | |
381 | ||
4b8ed631 | 382 | void *acpi_ut_allocate_object_desc_dbg(const char *module_name, |
4be44fcd | 383 | u32 line_number, u32 component_id) |
1da177e4 | 384 | { |
4be44fcd | 385 | union acpi_operand_object *object; |
1da177e4 | 386 | |
b229cf92 | 387 | ACPI_FUNCTION_TRACE(ut_allocate_object_desc_dbg); |
1da177e4 | 388 | |
4be44fcd | 389 | object = acpi_os_acquire_object(acpi_gbl_operand_cache); |
1da177e4 | 390 | if (!object) { |
b8e4d893 BM |
391 | ACPI_ERROR((module_name, line_number, |
392 | "Could not allocate an object descriptor")); | |
1da177e4 | 393 | |
4be44fcd | 394 | return_PTR(NULL); |
1da177e4 LT |
395 | } |
396 | ||
397 | /* Mark the descriptor type */ | |
8313524a | 398 | |
4be44fcd | 399 | ACPI_SET_DESCRIPTOR_TYPE(object, ACPI_DESC_TYPE_OPERAND); |
1da177e4 | 400 | |
4be44fcd LB |
401 | ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS, "%p Size %X\n", |
402 | object, (u32) sizeof(union acpi_operand_object))); | |
1da177e4 | 403 | |
4be44fcd | 404 | return_PTR(object); |
1da177e4 LT |
405 | } |
406 | ||
1da177e4 LT |
407 | /******************************************************************************* |
408 | * | |
409 | * FUNCTION: acpi_ut_delete_object_desc | |
410 | * | |
ba494bee | 411 | * PARAMETERS: object - An Acpi internal object to be deleted |
1da177e4 LT |
412 | * |
413 | * RETURN: None. | |
414 | * | |
415 | * DESCRIPTION: Free an ACPI object descriptor or add it to the object cache | |
416 | * | |
417 | ******************************************************************************/ | |
418 | ||
4be44fcd | 419 | void acpi_ut_delete_object_desc(union acpi_operand_object *object) |
1da177e4 | 420 | { |
b229cf92 | 421 | ACPI_FUNCTION_TRACE_PTR(ut_delete_object_desc, object); |
1da177e4 | 422 | |
75c8044f | 423 | /* Object must be of type union acpi_operand_object */ |
1da177e4 | 424 | |
4be44fcd | 425 | if (ACPI_GET_DESCRIPTOR_TYPE(object) != ACPI_DESC_TYPE_OPERAND) { |
b8e4d893 BM |
426 | ACPI_ERROR((AE_INFO, |
427 | "%p is not an ACPI Operand object [%s]", object, | |
428 | acpi_ut_get_descriptor_name(object))); | |
1da177e4 LT |
429 | return_VOID; |
430 | } | |
431 | ||
4be44fcd | 432 | (void)acpi_os_release_object(acpi_gbl_operand_cache, object); |
1da177e4 LT |
433 | return_VOID; |
434 | } | |
1da177e4 | 435 | |
1da177e4 LT |
436 | /******************************************************************************* |
437 | * | |
438 | * FUNCTION: acpi_ut_get_simple_object_size | |
439 | * | |
44f6c012 RM |
440 | * PARAMETERS: internal_object - An ACPI operand object |
441 | * obj_length - Where the length is returned | |
1da177e4 LT |
442 | * |
443 | * RETURN: Status | |
444 | * | |
445 | * DESCRIPTION: This function is called to determine the space required to | |
446 | * contain a simple object for return to an external user. | |
447 | * | |
448 | * The length includes the object structure plus any additional | |
449 | * needed space. | |
450 | * | |
451 | ******************************************************************************/ | |
452 | ||
44f6c012 | 453 | static acpi_status |
4be44fcd LB |
454 | acpi_ut_get_simple_object_size(union acpi_operand_object *internal_object, |
455 | acpi_size * obj_length) | |
1da177e4 | 456 | { |
4be44fcd | 457 | acpi_size length; |
3c7db22a | 458 | acpi_size size; |
4be44fcd | 459 | acpi_status status = AE_OK; |
1da177e4 | 460 | |
b229cf92 | 461 | ACPI_FUNCTION_TRACE_PTR(ut_get_simple_object_size, internal_object); |
1da177e4 | 462 | |
130797a6 LZ |
463 | /* Start with the length of the (external) Acpi object */ |
464 | ||
465 | length = sizeof(union acpi_object); | |
466 | ||
467 | /* A NULL object is allowed, can be a legal uninitialized package element */ | |
468 | ||
469 | if (!internal_object) { | |
44f6c012 | 470 | /* |
130797a6 LZ |
471 | * Object is NULL, just return the length of union acpi_object |
472 | * (A NULL union acpi_object is an object of all zeroes.) | |
44f6c012 | 473 | */ |
130797a6 | 474 | *obj_length = ACPI_ROUND_UP_TO_NATIVE_WORD(length); |
4be44fcd | 475 | return_ACPI_STATUS(AE_OK); |
1da177e4 LT |
476 | } |
477 | ||
130797a6 | 478 | /* A Namespace Node should never appear here */ |
1da177e4 | 479 | |
4be44fcd | 480 | if (ACPI_GET_DESCRIPTOR_TYPE(internal_object) == ACPI_DESC_TYPE_NAMED) { |
52fc0b02 | 481 | |
130797a6 | 482 | /* A namespace node should never get here */ |
1da177e4 | 483 | |
130797a6 | 484 | return_ACPI_STATUS(AE_AML_INTERNAL); |
1da177e4 LT |
485 | } |
486 | ||
487 | /* | |
488 | * The final length depends on the object type | |
489 | * Strings and Buffers are packed right up against the parent object and | |
490 | * must be accessed bytewise or there may be alignment problems on | |
491 | * certain processors | |
492 | */ | |
3371c19c | 493 | switch (internal_object->common.type) { |
1da177e4 LT |
494 | case ACPI_TYPE_STRING: |
495 | ||
496 | length += (acpi_size) internal_object->string.length + 1; | |
497 | break; | |
498 | ||
1da177e4 LT |
499 | case ACPI_TYPE_BUFFER: |
500 | ||
501 | length += (acpi_size) internal_object->buffer.length; | |
502 | break; | |
503 | ||
1da177e4 LT |
504 | case ACPI_TYPE_INTEGER: |
505 | case ACPI_TYPE_PROCESSOR: | |
506 | case ACPI_TYPE_POWER: | |
507 | ||
7a5bb996 LM |
508 | /* No extra data for these types */ |
509 | ||
1da177e4 LT |
510 | break; |
511 | ||
1da177e4 LT |
512 | case ACPI_TYPE_LOCAL_REFERENCE: |
513 | ||
1044f1f6 BM |
514 | switch (internal_object->reference.class) { |
515 | case ACPI_REFCLASS_NAME: | |
1da177e4 LT |
516 | /* |
517 | * Get the actual length of the full pathname to this object. | |
518 | * The reference will be converted to the pathname to the object | |
519 | */ | |
3c7db22a BM |
520 | size = |
521 | acpi_ns_get_pathname_length(internal_object-> | |
522 | reference.node); | |
523 | if (!size) { | |
524 | return_ACPI_STATUS(AE_BAD_PARAMETER); | |
525 | } | |
526 | ||
527 | length += ACPI_ROUND_UP_TO_NATIVE_WORD(size); | |
1da177e4 LT |
528 | break; |
529 | ||
530 | default: | |
1da177e4 LT |
531 | /* |
532 | * No other reference opcodes are supported. | |
533 | * Notably, Locals and Args are not supported, but this may be | |
534 | * required eventually. | |
535 | */ | |
b8e4d893 | 536 | ACPI_ERROR((AE_INFO, |
c2de3a49 | 537 | "Cannot convert to external object - " |
f6a22b0b | 538 | "unsupported Reference Class [%s] 0x%X in object %p", |
c2de3a49 | 539 | acpi_ut_get_reference_name(internal_object), |
1044f1f6 | 540 | internal_object->reference.class, |
b8e4d893 | 541 | internal_object)); |
1da177e4 LT |
542 | status = AE_TYPE; |
543 | break; | |
544 | } | |
545 | break; | |
546 | ||
1da177e4 LT |
547 | default: |
548 | ||
c2de3a49 | 549 | ACPI_ERROR((AE_INFO, "Cannot convert to external object - " |
f6a22b0b | 550 | "unsupported type [%s] 0x%X in object %p", |
c2de3a49 | 551 | acpi_ut_get_object_type_name(internal_object), |
3371c19c | 552 | internal_object->common.type, internal_object)); |
1da177e4 LT |
553 | status = AE_TYPE; |
554 | break; | |
555 | } | |
556 | ||
557 | /* | |
558 | * Account for the space required by the object rounded up to the next | |
73a3090a | 559 | * multiple of the machine word size. This keeps each object aligned |
1da177e4 LT |
560 | * on a machine word boundary. (preventing alignment faults on some |
561 | * machines.) | |
562 | */ | |
4be44fcd LB |
563 | *obj_length = ACPI_ROUND_UP_TO_NATIVE_WORD(length); |
564 | return_ACPI_STATUS(status); | |
1da177e4 LT |
565 | } |
566 | ||
1da177e4 LT |
567 | /******************************************************************************* |
568 | * | |
569 | * FUNCTION: acpi_ut_get_element_length | |
570 | * | |
571 | * PARAMETERS: acpi_pkg_callback | |
572 | * | |
573 | * RETURN: Status | |
574 | * | |
575 | * DESCRIPTION: Get the length of one package element. | |
576 | * | |
577 | ******************************************************************************/ | |
578 | ||
44f6c012 | 579 | static acpi_status |
4be44fcd LB |
580 | acpi_ut_get_element_length(u8 object_type, |
581 | union acpi_operand_object *source_object, | |
582 | union acpi_generic_state *state, void *context) | |
1da177e4 | 583 | { |
4be44fcd LB |
584 | acpi_status status = AE_OK; |
585 | struct acpi_pkg_info *info = (struct acpi_pkg_info *)context; | |
586 | acpi_size object_space; | |
1da177e4 LT |
587 | |
588 | switch (object_type) { | |
589 | case ACPI_COPY_TYPE_SIMPLE: | |
1da177e4 LT |
590 | /* |
591 | * Simple object - just get the size (Null object/entry is handled | |
592 | * here also) and sum it into the running package length | |
593 | */ | |
4be44fcd LB |
594 | status = |
595 | acpi_ut_get_simple_object_size(source_object, | |
596 | &object_space); | |
597 | if (ACPI_FAILURE(status)) { | |
1da177e4 LT |
598 | return (status); |
599 | } | |
600 | ||
601 | info->length += object_space; | |
602 | break; | |
603 | ||
1da177e4 LT |
604 | case ACPI_COPY_TYPE_PACKAGE: |
605 | ||
606 | /* Package object - nothing much to do here, let the walk handle it */ | |
607 | ||
608 | info->num_packages++; | |
609 | state->pkg.this_target_obj = NULL; | |
610 | break; | |
611 | ||
1da177e4 LT |
612 | default: |
613 | ||
614 | /* No other types allowed */ | |
615 | ||
616 | return (AE_BAD_PARAMETER); | |
617 | } | |
618 | ||
619 | return (status); | |
620 | } | |
621 | ||
1da177e4 LT |
622 | /******************************************************************************* |
623 | * | |
624 | * FUNCTION: acpi_ut_get_package_object_size | |
625 | * | |
44f6c012 RM |
626 | * PARAMETERS: internal_object - An ACPI internal object |
627 | * obj_length - Where the length is returned | |
1da177e4 LT |
628 | * |
629 | * RETURN: Status | |
630 | * | |
631 | * DESCRIPTION: This function is called to determine the space required to | |
632 | * contain a package object for return to an external user. | |
633 | * | |
634 | * This is moderately complex since a package contains other | |
635 | * objects including packages. | |
636 | * | |
637 | ******************************************************************************/ | |
638 | ||
44f6c012 | 639 | static acpi_status |
4be44fcd LB |
640 | acpi_ut_get_package_object_size(union acpi_operand_object *internal_object, |
641 | acpi_size * obj_length) | |
1da177e4 | 642 | { |
4be44fcd LB |
643 | acpi_status status; |
644 | struct acpi_pkg_info info; | |
1da177e4 | 645 | |
b229cf92 | 646 | ACPI_FUNCTION_TRACE_PTR(ut_get_package_object_size, internal_object); |
1da177e4 | 647 | |
4be44fcd | 648 | info.length = 0; |
1da177e4 LT |
649 | info.object_space = 0; |
650 | info.num_packages = 1; | |
651 | ||
4be44fcd LB |
652 | status = acpi_ut_walk_package_tree(internal_object, NULL, |
653 | acpi_ut_get_element_length, &info); | |
654 | if (ACPI_FAILURE(status)) { | |
655 | return_ACPI_STATUS(status); | |
1da177e4 LT |
656 | } |
657 | ||
658 | /* | |
659 | * We have handled all of the objects in all levels of the package. | |
660 | * just add the length of the package objects themselves. | |
661 | * Round up to the next machine word. | |
662 | */ | |
4be44fcd LB |
663 | info.length += ACPI_ROUND_UP_TO_NATIVE_WORD(sizeof(union acpi_object)) * |
664 | (acpi_size) info.num_packages; | |
1da177e4 LT |
665 | |
666 | /* Return the total package length */ | |
667 | ||
668 | *obj_length = info.length; | |
4be44fcd | 669 | return_ACPI_STATUS(status); |
1da177e4 LT |
670 | } |
671 | ||
1da177e4 LT |
672 | /******************************************************************************* |
673 | * | |
674 | * FUNCTION: acpi_ut_get_object_size | |
675 | * | |
44f6c012 RM |
676 | * PARAMETERS: internal_object - An ACPI internal object |
677 | * obj_length - Where the length will be returned | |
1da177e4 LT |
678 | * |
679 | * RETURN: Status | |
680 | * | |
681 | * DESCRIPTION: This function is called to determine the space required to | |
682 | * contain an object for return to an API user. | |
683 | * | |
684 | ******************************************************************************/ | |
685 | ||
686 | acpi_status | |
4be44fcd LB |
687 | acpi_ut_get_object_size(union acpi_operand_object *internal_object, |
688 | acpi_size * obj_length) | |
1da177e4 | 689 | { |
4be44fcd LB |
690 | acpi_status status; |
691 | ||
692 | ACPI_FUNCTION_ENTRY(); | |
693 | ||
694 | if ((ACPI_GET_DESCRIPTOR_TYPE(internal_object) == | |
695 | ACPI_DESC_TYPE_OPERAND) | |
3371c19c | 696 | && (internal_object->common.type == ACPI_TYPE_PACKAGE)) { |
4be44fcd LB |
697 | status = |
698 | acpi_ut_get_package_object_size(internal_object, | |
699 | obj_length); | |
700 | } else { | |
701 | status = | |
702 | acpi_ut_get_simple_object_size(internal_object, obj_length); | |
1da177e4 LT |
703 | } |
704 | ||
705 | return (status); | |
706 | } |