1 /*******************************************************************************
3 * Module Name: utmisc - common utility procedures
5 ******************************************************************************/
8 * Copyright (C) 2000 - 2006, R. Byron Moore
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
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.
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 <acpi/acnamesp.h>
47 #define _COMPONENT ACPI_UTILITIES
48 ACPI_MODULE_NAME("utmisc")
50 /*******************************************************************************
52 * FUNCTION: acpi_ut_allocate_owner_id
54 * PARAMETERS: owner_id - Where the new owner ID is returned
58 * DESCRIPTION: Allocate a table or method owner ID. The owner ID is used to
59 * track objects created by the table or method, to be deleted
60 * when the method exits or the table is unloaded.
62 ******************************************************************************/
63 acpi_status
acpi_ut_allocate_owner_id(acpi_owner_id
* owner_id
)
70 ACPI_FUNCTION_TRACE("ut_allocate_owner_id");
72 /* Guard against multiple allocations of ID to the same location */
75 ACPI_REPORT_ERROR(("Owner ID [%2.2X] already exists\n",
77 return_ACPI_STATUS(AE_ALREADY_EXISTS
);
80 /* Mutex for the global ID mask */
82 status
= acpi_ut_acquire_mutex(ACPI_MTX_CACHES
);
83 if (ACPI_FAILURE(status
)) {
84 return_ACPI_STATUS(status
);
88 * Find a free owner ID, cycle through all possible IDs on repeated
89 * allocations. (ACPI_NUM_OWNERID_MASKS + 1) because first index may have
90 * to be scanned twice.
92 for (i
= 0, j
= acpi_gbl_last_owner_id_index
;
93 i
< (ACPI_NUM_OWNERID_MASKS
+ 1); i
++, j
++) {
94 if (j
>= ACPI_NUM_OWNERID_MASKS
) {
95 j
= 0; /* Wraparound to start of mask array */
98 for (k
= acpi_gbl_next_owner_id_offset
; k
< 32; k
++) {
99 if (acpi_gbl_owner_id_mask
[j
] == ACPI_UINT32_MAX
) {
100 /* There are no free IDs in this mask */
105 if (!(acpi_gbl_owner_id_mask
[j
] & (1 << k
))) {
107 * Found a free ID. The actual ID is the bit index plus one,
108 * making zero an invalid Owner ID. Save this as the last ID
109 * allocated and update the global ID mask.
111 acpi_gbl_owner_id_mask
[j
] |= (1 << k
);
113 acpi_gbl_last_owner_id_index
= (u8
) j
;
114 acpi_gbl_next_owner_id_offset
= (u8
) (k
+ 1);
117 * Construct encoded ID from the index and bit position
119 * Note: Last [j].k (bit 255) is never used and is marked
120 * permanently allocated (prevents +1 overflow)
123 (acpi_owner_id
) ((k
+ 1) + ACPI_MUL_32(j
));
125 ACPI_DEBUG_PRINT((ACPI_DB_VALUES
,
126 "Allocated owner_id: %2.2X\n",
127 (unsigned int)*owner_id
));
132 acpi_gbl_next_owner_id_offset
= 0;
136 * All owner_ids have been allocated. This typically should
137 * not happen since the IDs are reused after deallocation. The IDs are
138 * allocated upon table load (one per table) and method execution, and
139 * they are released when a table is unloaded or a method completes
142 * If this error happens, there may be very deep nesting of invoked control
143 * methods, or there may be a bug where the IDs are not released.
145 status
= AE_OWNER_ID_LIMIT
;
146 ACPI_REPORT_ERROR(("Could not allocate new owner_id (255 max), AE_OWNER_ID_LIMIT\n"));
149 (void)acpi_ut_release_mutex(ACPI_MTX_CACHES
);
150 return_ACPI_STATUS(status
);
153 /*******************************************************************************
155 * FUNCTION: acpi_ut_release_owner_id
157 * PARAMETERS: owner_id_ptr - Pointer to a previously allocated owner_iD
159 * RETURN: None. No error is returned because we are either exiting a
160 * control method or unloading a table. Either way, we would
161 * ignore any error anyway.
163 * DESCRIPTION: Release a table or method owner ID. Valid IDs are 1 - 255
165 ******************************************************************************/
167 void acpi_ut_release_owner_id(acpi_owner_id
* owner_id_ptr
)
169 acpi_owner_id owner_id
= *owner_id_ptr
;
171 acpi_native_uint index
;
174 ACPI_FUNCTION_TRACE_U32("ut_release_owner_id", owner_id
);
176 /* Always clear the input owner_id (zero is an invalid ID) */
180 /* Zero is not a valid owner_iD */
183 ACPI_REPORT_ERROR(("Invalid owner_id: %2.2X\n", owner_id
));
187 /* Mutex for the global ID mask */
189 status
= acpi_ut_acquire_mutex(ACPI_MTX_CACHES
);
190 if (ACPI_FAILURE(status
)) {
194 /* Normalize the ID to zero */
198 /* Decode ID to index/offset pair */
200 index
= ACPI_DIV_32(owner_id
);
201 bit
= 1 << ACPI_MOD_32(owner_id
);
203 /* Free the owner ID only if it is valid */
205 if (acpi_gbl_owner_id_mask
[index
] & bit
) {
206 acpi_gbl_owner_id_mask
[index
] ^= bit
;
208 ACPI_REPORT_ERROR(("Release of non-allocated owner_id: %2.2X\n",
212 (void)acpi_ut_release_mutex(ACPI_MTX_CACHES
);
216 /*******************************************************************************
218 * FUNCTION: acpi_ut_strupr (strupr)
220 * PARAMETERS: src_string - The source string to convert
224 * DESCRIPTION: Convert string to uppercase
226 * NOTE: This is not a POSIX function, so it appears here, not in utclib.c
228 ******************************************************************************/
230 void acpi_ut_strupr(char *src_string
)
234 ACPI_FUNCTION_ENTRY();
240 /* Walk entire string, uppercasing the letters */
242 for (string
= src_string
; *string
; string
++) {
243 *string
= (char)ACPI_TOUPPER(*string
);
249 /*******************************************************************************
251 * FUNCTION: acpi_ut_print_string
253 * PARAMETERS: String - Null terminated ASCII string
254 * max_length - Maximum output length
258 * DESCRIPTION: Dump an ASCII string with support for ACPI-defined escape
261 ******************************************************************************/
263 void acpi_ut_print_string(char *string
, u8 max_length
)
268 acpi_os_printf("<\"NULL STRING PTR\">");
272 acpi_os_printf("\"");
273 for (i
= 0; string
[i
] && (i
< max_length
); i
++) {
274 /* Escape sequences */
278 acpi_os_printf("\\a"); /* BELL */
282 acpi_os_printf("\\b"); /* BACKSPACE */
286 acpi_os_printf("\\f"); /* FORMFEED */
290 acpi_os_printf("\\n"); /* LINEFEED */
294 acpi_os_printf("\\r"); /* CARRIAGE RETURN */
298 acpi_os_printf("\\t"); /* HORIZONTAL TAB */
302 acpi_os_printf("\\v"); /* VERTICAL TAB */
305 case '\'': /* Single Quote */
306 case '\"': /* Double Quote */
307 case '\\': /* Backslash */
308 acpi_os_printf("\\%c", (int)string
[i
]);
313 /* Check for printable character or hex escape */
315 if (ACPI_IS_PRINT(string
[i
])) {
316 /* This is a normal character */
318 acpi_os_printf("%c", (int)string
[i
]);
320 /* All others will be Hex escapes */
322 acpi_os_printf("\\x%2.2X", (s32
) string
[i
]);
327 acpi_os_printf("\"");
329 if (i
== max_length
&& string
[i
]) {
330 acpi_os_printf("...");
334 /*******************************************************************************
336 * FUNCTION: acpi_ut_dword_byte_swap
338 * PARAMETERS: Value - Value to be converted
340 * RETURN: u32 integer with bytes swapped
342 * DESCRIPTION: Convert a 32-bit value to big-endian (swap the bytes)
344 ******************************************************************************/
346 u32
acpi_ut_dword_byte_swap(u32 value
)
357 ACPI_FUNCTION_ENTRY();
361 out
.bytes
[0] = in
.bytes
[3];
362 out
.bytes
[1] = in
.bytes
[2];
363 out
.bytes
[2] = in
.bytes
[1];
364 out
.bytes
[3] = in
.bytes
[0];
369 /*******************************************************************************
371 * FUNCTION: acpi_ut_set_integer_width
373 * PARAMETERS: Revision From DSDT header
377 * DESCRIPTION: Set the global integer bit width based upon the revision
378 * of the DSDT. For Revision 1 and 0, Integers are 32 bits.
379 * For Revision 2 and above, Integers are 64 bits. Yes, this
380 * makes a difference.
382 ******************************************************************************/
384 void acpi_ut_set_integer_width(u8 revision
)
388 acpi_gbl_integer_bit_width
= 32;
389 acpi_gbl_integer_nybble_width
= 8;
390 acpi_gbl_integer_byte_width
= 4;
392 acpi_gbl_integer_bit_width
= 64;
393 acpi_gbl_integer_nybble_width
= 16;
394 acpi_gbl_integer_byte_width
= 8;
398 #ifdef ACPI_DEBUG_OUTPUT
399 /*******************************************************************************
401 * FUNCTION: acpi_ut_display_init_pathname
403 * PARAMETERS: Type - Object type of the node
404 * obj_handle - Handle whose pathname will be displayed
405 * Path - Additional path string to be appended.
406 * (NULL if no extra path)
408 * RETURN: acpi_status
410 * DESCRIPTION: Display full pathname of an object, DEBUG ONLY
412 ******************************************************************************/
415 acpi_ut_display_init_pathname(u8 type
,
416 struct acpi_namespace_node
*obj_handle
,
420 struct acpi_buffer buffer
;
422 ACPI_FUNCTION_ENTRY();
424 /* Only print the path if the appropriate debug level is enabled */
426 if (!(acpi_dbg_level
& ACPI_LV_INIT_NAMES
)) {
430 /* Get the full pathname to the node */
432 buffer
.length
= ACPI_ALLOCATE_LOCAL_BUFFER
;
433 status
= acpi_ns_handle_to_pathname(obj_handle
, &buffer
);
434 if (ACPI_FAILURE(status
)) {
438 /* Print what we're doing */
441 case ACPI_TYPE_METHOD
:
442 acpi_os_printf("Executing ");
446 acpi_os_printf("Initializing ");
450 /* Print the object type and pathname */
452 acpi_os_printf("%-12s %s",
453 acpi_ut_get_type_name(type
), (char *)buffer
.pointer
);
455 /* Extra path is used to append names like _STA, _INI, etc. */
458 acpi_os_printf(".%s", path
);
460 acpi_os_printf("\n");
462 ACPI_MEM_FREE(buffer
.pointer
);
466 /*******************************************************************************
468 * FUNCTION: acpi_ut_valid_acpi_name
470 * PARAMETERS: Name - The name to be examined
472 * RETURN: TRUE if the name is valid, FALSE otherwise
474 * DESCRIPTION: Check for a valid ACPI name. Each character must be one of:
475 * 1) Upper case alpha
479 ******************************************************************************/
481 u8
acpi_ut_valid_acpi_name(u32 name
)
483 char *name_ptr
= (char *)&name
;
487 ACPI_FUNCTION_ENTRY();
489 for (i
= 0; i
< ACPI_NAME_SIZE
; i
++) {
490 character
= *name_ptr
;
493 if (!((character
== '_') ||
494 (character
>= 'A' && character
<= 'Z') ||
495 (character
>= '0' && character
<= '9'))) {
503 /*******************************************************************************
505 * FUNCTION: acpi_ut_valid_acpi_character
507 * PARAMETERS: Character - The character to be examined
509 * RETURN: 1 if Character may appear in a name, else 0
511 * DESCRIPTION: Check for a printable character
513 ******************************************************************************/
515 u8
acpi_ut_valid_acpi_character(char character
)
518 ACPI_FUNCTION_ENTRY();
520 return ((u8
) ((character
== '_') ||
521 (character
>= 'A' && character
<= 'Z') ||
522 (character
>= '0' && character
<= '9')));
525 /*******************************************************************************
527 * FUNCTION: acpi_ut_strtoul64
529 * PARAMETERS: String - Null terminated string
530 * Base - Radix of the string: 10, 16, or ACPI_ANY_BASE
531 * ret_integer - Where the converted integer is returned
533 * RETURN: Status and Converted value
535 * DESCRIPTION: Convert a string into an unsigned value.
536 * NOTE: Does not support Octal strings, not needed.
538 ******************************************************************************/
541 acpi_ut_strtoul64(char *string
, u32 base
, acpi_integer
* ret_integer
)
544 acpi_integer return_value
= 0;
545 acpi_integer quotient
;
547 ACPI_FUNCTION_TRACE("ut_stroul64");
549 if ((!string
) || !(*string
)) {
561 return_ACPI_STATUS(AE_BAD_PARAMETER
);
564 /* Skip over any white space in the buffer */
566 while (ACPI_IS_SPACE(*string
) || *string
== '\t') {
571 * If the input parameter Base is zero, then we need to
572 * determine if it is decimal or hexadecimal:
575 if ((*string
== '0') && (ACPI_TOLOWER(*(string
+ 1)) == 'x')) {
584 * For hexadecimal base, skip over the leading
585 * 0 or 0x, if they are present.
588 (*string
== '0') && (ACPI_TOLOWER(*(string
+ 1)) == 'x')) {
592 /* Any string left? */
598 /* Main loop: convert the string to a 64-bit integer */
601 if (ACPI_IS_DIGIT(*string
)) {
602 /* Convert ASCII 0-9 to Decimal value */
604 this_digit
= ((u8
) * string
) - '0';
607 /* Digit is out of range */
612 this_digit
= (u8
) ACPI_TOUPPER(*string
);
613 if (ACPI_IS_XDIGIT((char)this_digit
)) {
614 /* Convert ASCII Hex char to value */
616 this_digit
= this_digit
- 'A' + 10;
619 * We allow non-hex chars, just stop now, same as end-of-string.
620 * See ACPI spec, string-to-integer conversion.
626 /* Divide the digit into the correct position */
629 acpi_ut_short_divide((ACPI_INTEGER_MAX
-
630 (acpi_integer
) this_digit
), base
,
632 if (return_value
> quotient
) {
636 return_value
*= base
;
637 return_value
+= this_digit
;
641 /* All done, normal exit */
643 *ret_integer
= return_value
;
644 return_ACPI_STATUS(AE_OK
);
647 /* Base was set/validated above */
650 return_ACPI_STATUS(AE_BAD_DECIMAL_CONSTANT
);
652 return_ACPI_STATUS(AE_BAD_HEX_CONSTANT
);
656 /*******************************************************************************
658 * FUNCTION: acpi_ut_create_update_state_and_push
660 * PARAMETERS: Object - Object to be added to the new state
661 * Action - Increment/Decrement
662 * state_list - List the state will be added to
666 * DESCRIPTION: Create a new state and push it
668 ******************************************************************************/
671 acpi_ut_create_update_state_and_push(union acpi_operand_object
*object
,
673 union acpi_generic_state
**state_list
)
675 union acpi_generic_state
*state
;
677 ACPI_FUNCTION_ENTRY();
679 /* Ignore null objects; these are expected */
685 state
= acpi_ut_create_update_state(object
, action
);
687 return (AE_NO_MEMORY
);
690 acpi_ut_push_generic_state(state_list
, state
);
694 /*******************************************************************************
696 * FUNCTION: acpi_ut_walk_package_tree
698 * PARAMETERS: source_object - The package to walk
699 * target_object - Target object (if package is being copied)
700 * walk_callback - Called once for each package element
701 * Context - Passed to the callback function
705 * DESCRIPTION: Walk through a package
707 ******************************************************************************/
710 acpi_ut_walk_package_tree(union acpi_operand_object
* source_object
,
712 acpi_pkg_callback walk_callback
, void *context
)
714 acpi_status status
= AE_OK
;
715 union acpi_generic_state
*state_list
= NULL
;
716 union acpi_generic_state
*state
;
718 union acpi_operand_object
*this_source_obj
;
720 ACPI_FUNCTION_TRACE("ut_walk_package_tree");
722 state
= acpi_ut_create_pkg_state(source_object
, target_object
, 0);
724 return_ACPI_STATUS(AE_NO_MEMORY
);
728 /* Get one element of the package */
730 this_index
= state
->pkg
.index
;
731 this_source_obj
= (union acpi_operand_object
*)
732 state
->pkg
.source_object
->package
.elements
[this_index
];
736 * 1) An uninitialized package element. It is completely
737 * legal to declare a package and leave it uninitialized
738 * 2) Not an internal object - can be a namespace node instead
739 * 3) Any type other than a package. Packages are handled in else
742 if ((!this_source_obj
) ||
743 (ACPI_GET_DESCRIPTOR_TYPE(this_source_obj
) !=
744 ACPI_DESC_TYPE_OPERAND
)
745 || (ACPI_GET_OBJECT_TYPE(this_source_obj
) !=
746 ACPI_TYPE_PACKAGE
)) {
748 walk_callback(ACPI_COPY_TYPE_SIMPLE
,
749 this_source_obj
, state
, context
);
750 if (ACPI_FAILURE(status
)) {
751 return_ACPI_STATUS(status
);
755 while (state
->pkg
.index
>=
756 state
->pkg
.source_object
->package
.count
) {
758 * We've handled all of the objects at this level, This means
759 * that we have just completed a package. That package may
760 * have contained one or more packages itself.
762 * Delete this state and pop the previous state (package).
764 acpi_ut_delete_generic_state(state
);
765 state
= acpi_ut_pop_generic_state(&state_list
);
767 /* Finished when there are no more states */
771 * We have handled all of the objects in the top level
772 * package just add the length of the package objects
775 return_ACPI_STATUS(AE_OK
);
779 * Go back up a level and move the index past the just
780 * completed package object.
785 /* This is a subobject of type package */
788 walk_callback(ACPI_COPY_TYPE_PACKAGE
,
789 this_source_obj
, state
, context
);
790 if (ACPI_FAILURE(status
)) {
791 return_ACPI_STATUS(status
);
795 * Push the current state and create a new one
796 * The callback above returned a new target package object.
798 acpi_ut_push_generic_state(&state_list
, state
);
799 state
= acpi_ut_create_pkg_state(this_source_obj
,
803 return_ACPI_STATUS(AE_NO_MEMORY
);
808 /* We should never get here */
810 return_ACPI_STATUS(AE_AML_INTERNAL
);
813 /*******************************************************************************
815 * FUNCTION: acpi_ut_generate_checksum
817 * PARAMETERS: Buffer - Buffer to be scanned
818 * Length - number of bytes to examine
820 * RETURN: The generated checksum
822 * DESCRIPTION: Generate a checksum on a raw buffer
824 ******************************************************************************/
826 u8
acpi_ut_generate_checksum(u8
* buffer
, u32 length
)
831 for (i
= 0; i
< length
; i
++) {
832 sum
= (signed char)(sum
+ buffer
[i
]);
835 return ((u8
) (0 - sum
));
838 /*******************************************************************************
840 * FUNCTION: acpi_ut_report_error
842 * PARAMETERS: module_name - Caller's module name (for error output)
843 * line_number - Caller's line number (for error output)
847 * DESCRIPTION: Print error message
849 ******************************************************************************/
851 void acpi_ut_report_error(char *module_name
, u32 line_number
)
854 acpi_os_printf("ACPI Error (%s-%04d): ", module_name
, line_number
);
857 /*******************************************************************************
859 * FUNCTION: acpi_ut_report_warning
861 * PARAMETERS: module_name - Caller's module name (for error output)
862 * line_number - Caller's line number (for error output)
866 * DESCRIPTION: Print warning message
868 ******************************************************************************/
870 void acpi_ut_report_warning(char *module_name
, u32 line_number
)
873 acpi_os_printf("ACPI Warning (%s-%04d): ", module_name
, line_number
);
876 /*******************************************************************************
878 * FUNCTION: acpi_ut_report_info
880 * PARAMETERS: module_name - Caller's module name (for error output)
881 * line_number - Caller's line number (for error output)
885 * DESCRIPTION: Print information message
887 ******************************************************************************/
889 void acpi_ut_report_info(char *module_name
, u32 line_number
)
892 acpi_os_printf("ACPI (%s-%04d): ", module_name
, line_number
);