Linux 4.1.16
[linux/fpc-iii.git] / drivers / acpi / acpica / utobject.c
blob7d83efe1ea296415bf7f57318a239a64d6e856a4
1 /******************************************************************************
3 * Module Name: utobject - ACPI object create/delete/size/cache routines
5 *****************************************************************************/
7 /*
8 * Copyright (C) 2000 - 2015, Intel Corp.
9 * All rights reserved.
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.
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.
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.
44 #include <acpi/acpi.h>
45 #include "accommon.h"
46 #include "acnamesp.h"
48 #define _COMPONENT ACPI_UTILITIES
49 ACPI_MODULE_NAME("utobject")
51 /* Local prototypes */
52 static acpi_status
53 acpi_ut_get_simple_object_size(union acpi_operand_object *obj,
54 acpi_size * obj_length);
56 static acpi_status
57 acpi_ut_get_package_object_size(union acpi_operand_object *obj,
58 acpi_size * obj_length);
60 static acpi_status
61 acpi_ut_get_element_length(u8 object_type,
62 union acpi_operand_object *source_object,
63 union acpi_generic_state *state, void *context);
65 /*******************************************************************************
67 * FUNCTION: acpi_ut_create_internal_object_dbg
69 * PARAMETERS: module_name - Source file name of caller
70 * line_number - Line number of caller
71 * component_id - Component type of caller
72 * type - ACPI Type of the new object
74 * RETURN: A new internal object, null on failure
76 * DESCRIPTION: Create and initialize a new internal object.
78 * NOTE: We always allocate the worst-case object descriptor because
79 * these objects are cached, and we want them to be
80 * one-size-satisifies-any-request. This in itself may not be
81 * the most memory efficient, but the efficiency of the object
82 * cache should more than make up for this!
84 ******************************************************************************/
86 union acpi_operand_object *acpi_ut_create_internal_object_dbg(const char
87 *module_name,
88 u32 line_number,
89 u32 component_id,
90 acpi_object_type
91 type)
93 union acpi_operand_object *object;
94 union acpi_operand_object *second_object;
96 ACPI_FUNCTION_TRACE_STR(ut_create_internal_object_dbg,
97 acpi_ut_get_type_name(type));
99 /* Allocate the raw object descriptor */
101 object =
102 acpi_ut_allocate_object_desc_dbg(module_name, line_number,
103 component_id);
104 if (!object) {
105 return_PTR(NULL);
108 switch (type) {
109 case ACPI_TYPE_REGION:
110 case ACPI_TYPE_BUFFER_FIELD:
111 case ACPI_TYPE_LOCAL_BANK_FIELD:
113 /* These types require a secondary object */
115 second_object = acpi_ut_allocate_object_desc_dbg(module_name,
116 line_number,
117 component_id);
118 if (!second_object) {
119 acpi_ut_delete_object_desc(object);
120 return_PTR(NULL);
123 second_object->common.type = ACPI_TYPE_LOCAL_EXTRA;
124 second_object->common.reference_count = 1;
126 /* Link the second object to the first */
128 object->common.next_object = second_object;
129 break;
131 default:
133 /* All others have no secondary object */
134 break;
137 /* Save the object type in the object descriptor */
139 object->common.type = (u8) type;
141 /* Init the reference count */
143 object->common.reference_count = 1;
145 /* Any per-type initialization should go here */
147 return_PTR(object);
150 /*******************************************************************************
152 * FUNCTION: acpi_ut_create_package_object
154 * PARAMETERS: count - Number of package elements
156 * RETURN: Pointer to a new Package object, null on failure
158 * DESCRIPTION: Create a fully initialized package object
160 ******************************************************************************/
162 union acpi_operand_object *acpi_ut_create_package_object(u32 count)
164 union acpi_operand_object *package_desc;
165 union acpi_operand_object **package_elements;
167 ACPI_FUNCTION_TRACE_U32(ut_create_package_object, count);
169 /* Create a new Package object */
171 package_desc = acpi_ut_create_internal_object(ACPI_TYPE_PACKAGE);
172 if (!package_desc) {
173 return_PTR(NULL);
177 * Create the element array. Count+1 allows the array to be null
178 * terminated.
180 package_elements = ACPI_ALLOCATE_ZEROED(((acpi_size) count +
181 1) * sizeof(void *));
182 if (!package_elements) {
183 ACPI_FREE(package_desc);
184 return_PTR(NULL);
187 package_desc->package.count = count;
188 package_desc->package.elements = package_elements;
189 return_PTR(package_desc);
192 /*******************************************************************************
194 * FUNCTION: acpi_ut_create_integer_object
196 * PARAMETERS: initial_value - Initial value for the integer
198 * RETURN: Pointer to a new Integer object, null on failure
200 * DESCRIPTION: Create an initialized integer object
202 ******************************************************************************/
204 union acpi_operand_object *acpi_ut_create_integer_object(u64 initial_value)
206 union acpi_operand_object *integer_desc;
208 ACPI_FUNCTION_TRACE(ut_create_integer_object);
210 /* Create and initialize a new integer object */
212 integer_desc = acpi_ut_create_internal_object(ACPI_TYPE_INTEGER);
213 if (!integer_desc) {
214 return_PTR(NULL);
217 integer_desc->integer.value = initial_value;
218 return_PTR(integer_desc);
221 /*******************************************************************************
223 * FUNCTION: acpi_ut_create_buffer_object
225 * PARAMETERS: buffer_size - Size of buffer to be created
227 * RETURN: Pointer to a new Buffer object, null on failure
229 * DESCRIPTION: Create a fully initialized buffer object
231 ******************************************************************************/
233 union acpi_operand_object *acpi_ut_create_buffer_object(acpi_size buffer_size)
235 union acpi_operand_object *buffer_desc;
236 u8 *buffer = NULL;
238 ACPI_FUNCTION_TRACE_U32(ut_create_buffer_object, buffer_size);
240 /* Create a new Buffer object */
242 buffer_desc = acpi_ut_create_internal_object(ACPI_TYPE_BUFFER);
243 if (!buffer_desc) {
244 return_PTR(NULL);
247 /* Create an actual buffer only if size > 0 */
249 if (buffer_size > 0) {
251 /* Allocate the actual buffer */
253 buffer = ACPI_ALLOCATE_ZEROED(buffer_size);
254 if (!buffer) {
255 ACPI_ERROR((AE_INFO, "Could not allocate size %u",
256 (u32) buffer_size));
257 acpi_ut_remove_reference(buffer_desc);
258 return_PTR(NULL);
262 /* Complete buffer object initialization */
264 buffer_desc->buffer.flags |= AOPOBJ_DATA_VALID;
265 buffer_desc->buffer.pointer = buffer;
266 buffer_desc->buffer.length = (u32) buffer_size;
268 /* Return the new buffer descriptor */
270 return_PTR(buffer_desc);
273 /*******************************************************************************
275 * FUNCTION: acpi_ut_create_string_object
277 * PARAMETERS: string_size - Size of string to be created. Does not
278 * include NULL terminator, this is added
279 * automatically.
281 * RETURN: Pointer to a new String object
283 * DESCRIPTION: Create a fully initialized string object
285 ******************************************************************************/
287 union acpi_operand_object *acpi_ut_create_string_object(acpi_size string_size)
289 union acpi_operand_object *string_desc;
290 char *string;
292 ACPI_FUNCTION_TRACE_U32(ut_create_string_object, string_size);
294 /* Create a new String object */
296 string_desc = acpi_ut_create_internal_object(ACPI_TYPE_STRING);
297 if (!string_desc) {
298 return_PTR(NULL);
302 * Allocate the actual string buffer -- (Size + 1) for NULL terminator.
303 * NOTE: Zero-length strings are NULL terminated
305 string = ACPI_ALLOCATE_ZEROED(string_size + 1);
306 if (!string) {
307 ACPI_ERROR((AE_INFO, "Could not allocate size %u",
308 (u32) string_size));
309 acpi_ut_remove_reference(string_desc);
310 return_PTR(NULL);
313 /* Complete string object initialization */
315 string_desc->string.pointer = string;
316 string_desc->string.length = (u32) string_size;
318 /* Return the new string descriptor */
320 return_PTR(string_desc);
323 /*******************************************************************************
325 * FUNCTION: acpi_ut_valid_internal_object
327 * PARAMETERS: object - Object to be validated
329 * RETURN: TRUE if object is valid, FALSE otherwise
331 * DESCRIPTION: Validate a pointer to be of type union acpi_operand_object
333 ******************************************************************************/
335 u8 acpi_ut_valid_internal_object(void *object)
338 ACPI_FUNCTION_NAME(ut_valid_internal_object);
340 /* Check for a null pointer */
342 if (!object) {
343 ACPI_DEBUG_PRINT((ACPI_DB_EXEC, "**** Null Object Ptr\n"));
344 return (FALSE);
347 /* Check the descriptor type field */
349 switch (ACPI_GET_DESCRIPTOR_TYPE(object)) {
350 case ACPI_DESC_TYPE_OPERAND:
352 /* The object appears to be a valid union acpi_operand_object */
354 return (TRUE);
356 default:
358 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
359 "%p is not an ACPI operand obj [%s]\n",
360 object, acpi_ut_get_descriptor_name(object)));
361 break;
364 return (FALSE);
367 /*******************************************************************************
369 * FUNCTION: acpi_ut_allocate_object_desc_dbg
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)
375 * RETURN: Pointer to newly allocated object descriptor. Null on error
377 * DESCRIPTION: Allocate a new object descriptor. Gracefully handle
378 * error conditions.
380 ******************************************************************************/
382 void *acpi_ut_allocate_object_desc_dbg(const char *module_name,
383 u32 line_number, u32 component_id)
385 union acpi_operand_object *object;
387 ACPI_FUNCTION_TRACE(ut_allocate_object_desc_dbg);
389 object = acpi_os_acquire_object(acpi_gbl_operand_cache);
390 if (!object) {
391 ACPI_ERROR((module_name, line_number,
392 "Could not allocate an object descriptor"));
394 return_PTR(NULL);
397 /* Mark the descriptor type */
399 ACPI_SET_DESCRIPTOR_TYPE(object, ACPI_DESC_TYPE_OPERAND);
401 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS, "%p Size %X\n",
402 object, (u32) sizeof(union acpi_operand_object)));
404 return_PTR(object);
407 /*******************************************************************************
409 * FUNCTION: acpi_ut_delete_object_desc
411 * PARAMETERS: object - An Acpi internal object to be deleted
413 * RETURN: None.
415 * DESCRIPTION: Free an ACPI object descriptor or add it to the object cache
417 ******************************************************************************/
419 void acpi_ut_delete_object_desc(union acpi_operand_object *object)
421 ACPI_FUNCTION_TRACE_PTR(ut_delete_object_desc, object);
423 /* Object must be of type union acpi_operand_object */
425 if (ACPI_GET_DESCRIPTOR_TYPE(object) != ACPI_DESC_TYPE_OPERAND) {
426 ACPI_ERROR((AE_INFO,
427 "%p is not an ACPI Operand object [%s]", object,
428 acpi_ut_get_descriptor_name(object)));
429 return_VOID;
432 (void)acpi_os_release_object(acpi_gbl_operand_cache, object);
433 return_VOID;
436 /*******************************************************************************
438 * FUNCTION: acpi_ut_get_simple_object_size
440 * PARAMETERS: internal_object - An ACPI operand object
441 * obj_length - Where the length is returned
443 * RETURN: Status
445 * DESCRIPTION: This function is called to determine the space required to
446 * contain a simple object for return to an external user.
448 * The length includes the object structure plus any additional
449 * needed space.
451 ******************************************************************************/
453 static acpi_status
454 acpi_ut_get_simple_object_size(union acpi_operand_object *internal_object,
455 acpi_size * obj_length)
457 acpi_size length;
458 acpi_size size;
459 acpi_status status = AE_OK;
461 ACPI_FUNCTION_TRACE_PTR(ut_get_simple_object_size, internal_object);
463 /* Start with the length of the (external) Acpi object */
465 length = sizeof(union acpi_object);
467 /* A NULL object is allowed, can be a legal uninitialized package element */
469 if (!internal_object) {
471 * Object is NULL, just return the length of union acpi_object
472 * (A NULL union acpi_object is an object of all zeroes.)
474 *obj_length = ACPI_ROUND_UP_TO_NATIVE_WORD(length);
475 return_ACPI_STATUS(AE_OK);
478 /* A Namespace Node should never appear here */
480 if (ACPI_GET_DESCRIPTOR_TYPE(internal_object) == ACPI_DESC_TYPE_NAMED) {
482 /* A namespace node should never get here */
484 return_ACPI_STATUS(AE_AML_INTERNAL);
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
493 switch (internal_object->common.type) {
494 case ACPI_TYPE_STRING:
496 length += (acpi_size) internal_object->string.length + 1;
497 break;
499 case ACPI_TYPE_BUFFER:
501 length += (acpi_size) internal_object->buffer.length;
502 break;
504 case ACPI_TYPE_INTEGER:
505 case ACPI_TYPE_PROCESSOR:
506 case ACPI_TYPE_POWER:
508 /* No extra data for these types */
510 break;
512 case ACPI_TYPE_LOCAL_REFERENCE:
514 switch (internal_object->reference.class) {
515 case ACPI_REFCLASS_NAME:
517 * Get the actual length of the full pathname to this object.
518 * The reference will be converted to the pathname to the object
520 size =
521 acpi_ns_get_pathname_length(internal_object->
522 reference.node);
523 if (!size) {
524 return_ACPI_STATUS(AE_BAD_PARAMETER);
527 length += ACPI_ROUND_UP_TO_NATIVE_WORD(size);
528 break;
530 default:
532 * No other reference opcodes are supported.
533 * Notably, Locals and Args are not supported, but this may be
534 * required eventually.
536 ACPI_ERROR((AE_INFO,
537 "Cannot convert to external object - "
538 "unsupported Reference Class [%s] 0x%X in object %p",
539 acpi_ut_get_reference_name(internal_object),
540 internal_object->reference.class,
541 internal_object));
542 status = AE_TYPE;
543 break;
545 break;
547 default:
549 ACPI_ERROR((AE_INFO, "Cannot convert to external object - "
550 "unsupported type [%s] 0x%X in object %p",
551 acpi_ut_get_object_type_name(internal_object),
552 internal_object->common.type, internal_object));
553 status = AE_TYPE;
554 break;
558 * Account for the space required by the object rounded up to the next
559 * multiple of the machine word size. This keeps each object aligned
560 * on a machine word boundary. (preventing alignment faults on some
561 * machines.)
563 *obj_length = ACPI_ROUND_UP_TO_NATIVE_WORD(length);
564 return_ACPI_STATUS(status);
567 /*******************************************************************************
569 * FUNCTION: acpi_ut_get_element_length
571 * PARAMETERS: acpi_pkg_callback
573 * RETURN: Status
575 * DESCRIPTION: Get the length of one package element.
577 ******************************************************************************/
579 static acpi_status
580 acpi_ut_get_element_length(u8 object_type,
581 union acpi_operand_object *source_object,
582 union acpi_generic_state *state, void *context)
584 acpi_status status = AE_OK;
585 struct acpi_pkg_info *info = (struct acpi_pkg_info *)context;
586 acpi_size object_space;
588 switch (object_type) {
589 case ACPI_COPY_TYPE_SIMPLE:
591 * Simple object - just get the size (Null object/entry is handled
592 * here also) and sum it into the running package length
594 status =
595 acpi_ut_get_simple_object_size(source_object,
596 &object_space);
597 if (ACPI_FAILURE(status)) {
598 return (status);
601 info->length += object_space;
602 break;
604 case ACPI_COPY_TYPE_PACKAGE:
606 /* Package object - nothing much to do here, let the walk handle it */
608 info->num_packages++;
609 state->pkg.this_target_obj = NULL;
610 break;
612 default:
614 /* No other types allowed */
616 return (AE_BAD_PARAMETER);
619 return (status);
622 /*******************************************************************************
624 * FUNCTION: acpi_ut_get_package_object_size
626 * PARAMETERS: internal_object - An ACPI internal object
627 * obj_length - Where the length is returned
629 * RETURN: Status
631 * DESCRIPTION: This function is called to determine the space required to
632 * contain a package object for return to an external user.
634 * This is moderately complex since a package contains other
635 * objects including packages.
637 ******************************************************************************/
639 static acpi_status
640 acpi_ut_get_package_object_size(union acpi_operand_object *internal_object,
641 acpi_size * obj_length)
643 acpi_status status;
644 struct acpi_pkg_info info;
646 ACPI_FUNCTION_TRACE_PTR(ut_get_package_object_size, internal_object);
648 info.length = 0;
649 info.object_space = 0;
650 info.num_packages = 1;
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);
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.
663 info.length += ACPI_ROUND_UP_TO_NATIVE_WORD(sizeof(union acpi_object)) *
664 (acpi_size) info.num_packages;
666 /* Return the total package length */
668 *obj_length = info.length;
669 return_ACPI_STATUS(status);
672 /*******************************************************************************
674 * FUNCTION: acpi_ut_get_object_size
676 * PARAMETERS: internal_object - An ACPI internal object
677 * obj_length - Where the length will be returned
679 * RETURN: Status
681 * DESCRIPTION: This function is called to determine the space required to
682 * contain an object for return to an API user.
684 ******************************************************************************/
686 acpi_status
687 acpi_ut_get_object_size(union acpi_operand_object *internal_object,
688 acpi_size * obj_length)
690 acpi_status status;
692 ACPI_FUNCTION_ENTRY();
694 if ((ACPI_GET_DESCRIPTOR_TYPE(internal_object) ==
695 ACPI_DESC_TYPE_OPERAND)
696 && (internal_object->common.type == ACPI_TYPE_PACKAGE)) {
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);
705 return (status);