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