1 /*******************************************************************************
3 * Module Name: utmisc - common utility procedures
5 ******************************************************************************/
8 * Copyright (C) 2000 - 2005, 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.
45 #include <acpi/acpi.h>
46 #include <acpi/acnamesp.h>
49 #define _COMPONENT ACPI_UTILITIES
50 ACPI_MODULE_NAME ("utmisc")
53 /*******************************************************************************
55 * FUNCTION: acpi_ut_allocate_owner_id
57 * PARAMETERS: owner_id - Where the new owner ID is returned
61 * DESCRIPTION: Allocate a table or method owner ID. The owner ID is used to
62 * track objects created by the table or method, to be deleted
63 * when the method exits or the table is unloaded.
65 ******************************************************************************/
68 acpi_ut_allocate_owner_id (
69 acpi_owner_id *owner_id)
75 ACPI_FUNCTION_TRACE ("ut_allocate_owner_id");
78 /* Mutex for the global ID mask */
80 status = acpi_ut_acquire_mutex (ACPI_MTX_CACHES);
81 if (ACPI_FAILURE (status)) {
82 return_ACPI_STATUS (status);
85 /* Find a free owner ID */
87 for (i = 0; i < 32; i++) {
88 if (!(acpi_gbl_owner_id_mask & (1 << i))) {
89 acpi_gbl_owner_id_mask |= (1 << i);
90 *owner_id = (acpi_owner_id) (i + 1);
96 * If we are here, all owner_ids have been allocated. This probably should
97 * not happen since the IDs are reused after deallocation. The IDs are
98 * allocated upon table load (one per table) and method execution, and
99 * they are released when a table is unloaded or a method completes
103 status = AE_OWNER_ID_LIMIT;
105 "Could not allocate new owner_id (32 max), AE_OWNER_ID_LIMIT\n"));
108 (void) acpi_ut_release_mutex (ACPI_MTX_CACHES);
109 return_ACPI_STATUS (status);
113 /*******************************************************************************
115 * FUNCTION: acpi_ut_release_owner_id
117 * PARAMETERS: owner_id_ptr - Pointer to a previously allocated owner_iD
119 * RETURN: None. No error is returned because we are either exiting a
120 * control method or unloading a table. Either way, we would
121 * ignore any error anyway.
123 * DESCRIPTION: Release a table or method owner ID. Valid IDs are 1 - 32
125 ******************************************************************************/
128 acpi_ut_release_owner_id (
129 acpi_owner_id *owner_id_ptr)
131 acpi_owner_id owner_id = *owner_id_ptr;
135 ACPI_FUNCTION_TRACE ("ut_release_owner_id");
138 /* Always clear the input owner_id (zero is an invalid ID) */
142 /* Zero is not a valid owner_iD */
144 if ((owner_id == 0) || (owner_id > 32)) {
145 ACPI_REPORT_ERROR (("Invalid owner_id: %2.2X\n", owner_id));
149 /* Mutex for the global ID mask */
151 status = acpi_ut_acquire_mutex (ACPI_MTX_CACHES);
152 if (ACPI_FAILURE (status)) {
156 owner_id--; /* Normalize to zero */
158 /* Free the owner ID only if it is valid */
160 if (acpi_gbl_owner_id_mask & (1 << owner_id)) {
161 acpi_gbl_owner_id_mask ^= (1 << owner_id);
164 (void) acpi_ut_release_mutex (ACPI_MTX_CACHES);
169 /*******************************************************************************
171 * FUNCTION: acpi_ut_strupr (strupr)
173 * PARAMETERS: src_string - The source string to convert
177 * DESCRIPTION: Convert string to uppercase
179 * NOTE: This is not a POSIX function, so it appears here, not in utclib.c
181 ******************************************************************************/
190 ACPI_FUNCTION_ENTRY ();
197 /* Walk entire string, uppercasing the letters */
199 for (string = src_string; *string; string++) {
200 *string = (char) ACPI_TOUPPER (*string);
207 /*******************************************************************************
209 * FUNCTION: acpi_ut_print_string
211 * PARAMETERS: String - Null terminated ASCII string
212 * max_length - Maximum output length
216 * DESCRIPTION: Dump an ASCII string with support for ACPI-defined escape
219 ******************************************************************************/
222 acpi_ut_print_string (
230 acpi_os_printf ("<\"NULL STRING PTR\">");
234 acpi_os_printf ("\"");
235 for (i = 0; string[i] && (i < max_length); i++) {
236 /* Escape sequences */
240 acpi_os_printf ("\\a"); /* BELL */
244 acpi_os_printf ("\\b"); /* BACKSPACE */
248 acpi_os_printf ("\\f"); /* FORMFEED */
252 acpi_os_printf ("\\n"); /* LINEFEED */
256 acpi_os_printf ("\\r"); /* CARRIAGE RETURN*/
260 acpi_os_printf ("\\t"); /* HORIZONTAL TAB */
264 acpi_os_printf ("\\v"); /* VERTICAL TAB */
267 case '\'': /* Single Quote */
268 case '\"': /* Double Quote */
269 case '\\': /* Backslash */
270 acpi_os_printf ("\\%c", (int) string[i]);
275 /* Check for printable character or hex escape */
277 if (ACPI_IS_PRINT (string[i]))
279 /* This is a normal character */
281 acpi_os_printf ("%c", (int) string[i]);
285 /* All others will be Hex escapes */
287 acpi_os_printf ("\\x%2.2X", (s32) string[i]);
292 acpi_os_printf ("\"");
294 if (i == max_length && string[i]) {
295 acpi_os_printf ("...");
300 /*******************************************************************************
302 * FUNCTION: acpi_ut_dword_byte_swap
304 * PARAMETERS: Value - Value to be converted
306 * RETURN: u32 integer with bytes swapped
308 * DESCRIPTION: Convert a 32-bit value to big-endian (swap the bytes)
310 ******************************************************************************/
313 acpi_ut_dword_byte_swap (
326 ACPI_FUNCTION_ENTRY ();
331 out.bytes[0] = in.bytes[3];
332 out.bytes[1] = in.bytes[2];
333 out.bytes[2] = in.bytes[1];
334 out.bytes[3] = in.bytes[0];
340 /*******************************************************************************
342 * FUNCTION: acpi_ut_set_integer_width
344 * PARAMETERS: Revision From DSDT header
348 * DESCRIPTION: Set the global integer bit width based upon the revision
349 * of the DSDT. For Revision 1 and 0, Integers are 32 bits.
350 * For Revision 2 and above, Integers are 64 bits. Yes, this
351 * makes a difference.
353 ******************************************************************************/
356 acpi_ut_set_integer_width (
361 acpi_gbl_integer_bit_width = 32;
362 acpi_gbl_integer_nybble_width = 8;
363 acpi_gbl_integer_byte_width = 4;
366 acpi_gbl_integer_bit_width = 64;
367 acpi_gbl_integer_nybble_width = 16;
368 acpi_gbl_integer_byte_width = 8;
373 #ifdef ACPI_DEBUG_OUTPUT
374 /*******************************************************************************
376 * FUNCTION: acpi_ut_display_init_pathname
378 * PARAMETERS: Type - Object type of the node
379 * obj_handle - Handle whose pathname will be displayed
380 * Path - Additional path string to be appended.
381 * (NULL if no extra path)
383 * RETURN: acpi_status
385 * DESCRIPTION: Display full pathname of an object, DEBUG ONLY
387 ******************************************************************************/
390 acpi_ut_display_init_pathname (
392 struct acpi_namespace_node *obj_handle,
396 struct acpi_buffer buffer;
399 ACPI_FUNCTION_ENTRY ();
402 /* Only print the path if the appropriate debug level is enabled */
404 if (!(acpi_dbg_level & ACPI_LV_INIT_NAMES)) {
408 /* Get the full pathname to the node */
410 buffer.length = ACPI_ALLOCATE_LOCAL_BUFFER;
411 status = acpi_ns_handle_to_pathname (obj_handle, &buffer);
412 if (ACPI_FAILURE (status)) {
416 /* Print what we're doing */
419 case ACPI_TYPE_METHOD:
420 acpi_os_printf ("Executing ");
424 acpi_os_printf ("Initializing ");
428 /* Print the object type and pathname */
430 acpi_os_printf ("%-12s %s",
431 acpi_ut_get_type_name (type), (char *) buffer.pointer);
433 /* Extra path is used to append names like _STA, _INI, etc. */
436 acpi_os_printf (".%s", path);
438 acpi_os_printf ("\n");
440 ACPI_MEM_FREE (buffer.pointer);
445 /*******************************************************************************
447 * FUNCTION: acpi_ut_valid_acpi_name
449 * PARAMETERS: Name - The name to be examined
451 * RETURN: TRUE if the name is valid, FALSE otherwise
453 * DESCRIPTION: Check for a valid ACPI name. Each character must be one of:
454 * 1) Upper case alpha
458 ******************************************************************************/
461 acpi_ut_valid_acpi_name (
464 char *name_ptr = (char *) &name;
469 ACPI_FUNCTION_ENTRY ();
472 for (i = 0; i < ACPI_NAME_SIZE; i++) {
473 character = *name_ptr;
476 if (!((character == '_') ||
477 (character >= 'A' && character <= 'Z') ||
478 (character >= '0' && character <= '9'))) {
487 /*******************************************************************************
489 * FUNCTION: acpi_ut_valid_acpi_character
491 * PARAMETERS: Character - The character to be examined
493 * RETURN: 1 if Character may appear in a name, else 0
495 * DESCRIPTION: Check for a printable character
497 ******************************************************************************/
500 acpi_ut_valid_acpi_character (
504 ACPI_FUNCTION_ENTRY ();
506 return ((u8) ((character == '_') ||
507 (character >= 'A' && character <= 'Z') ||
508 (character >= '0' && character <= '9')));
512 /*******************************************************************************
514 * FUNCTION: acpi_ut_strtoul64
516 * PARAMETERS: String - Null terminated string
517 * Base - Radix of the string: 10, 16, or ACPI_ANY_BASE
518 * ret_integer - Where the converted integer is returned
520 * RETURN: Status and Converted value
522 * DESCRIPTION: Convert a string into an unsigned value.
523 * NOTE: Does not support Octal strings, not needed.
525 ******************************************************************************/
531 acpi_integer *ret_integer)
534 acpi_integer return_value = 0;
535 acpi_integer quotient;
538 ACPI_FUNCTION_TRACE ("ut_stroul64");
541 if ((!string) || !(*string)) {
553 return_ACPI_STATUS (AE_BAD_PARAMETER);
556 /* Skip over any white space in the buffer */
558 while (ACPI_IS_SPACE (*string) || *string == '\t') {
563 * If the input parameter Base is zero, then we need to
564 * determine if it is decimal or hexadecimal:
567 if ((*string == '0') &&
568 (ACPI_TOLOWER (*(string + 1)) == 'x')) {
578 * For hexadecimal base, skip over the leading
579 * 0 or 0x, if they are present.
583 (ACPI_TOLOWER (*(string + 1)) == 'x')) {
587 /* Any string left? */
593 /* Main loop: convert the string to a 64-bit integer */
596 if (ACPI_IS_DIGIT (*string)) {
597 /* Convert ASCII 0-9 to Decimal value */
599 this_digit = ((u8) *string) - '0';
603 /* Digit is out of range */
608 this_digit = (u8) ACPI_TOUPPER (*string);
609 if (ACPI_IS_XDIGIT ((char) this_digit)) {
610 /* Convert ASCII Hex char to value */
612 this_digit = this_digit - 'A' + 10;
616 * We allow non-hex chars, just stop now, same as end-of-string.
617 * See ACPI spec, string-to-integer conversion.
623 /* Divide the digit into the correct position */
625 (void) acpi_ut_short_divide ((ACPI_INTEGER_MAX - (acpi_integer) this_digit),
626 base, "ient, NULL);
627 if (return_value > quotient) {
631 return_value *= base;
632 return_value += this_digit;
636 /* All done, normal exit */
638 *ret_integer = return_value;
639 return_ACPI_STATUS (AE_OK);
643 /* Base was set/validated above */
646 return_ACPI_STATUS (AE_BAD_DECIMAL_CONSTANT);
649 return_ACPI_STATUS (AE_BAD_HEX_CONSTANT);
654 /*******************************************************************************
656 * FUNCTION: acpi_ut_create_update_state_and_push
658 * PARAMETERS: Object - Object to be added to the new state
659 * Action - Increment/Decrement
660 * state_list - List the state will be added to
664 * DESCRIPTION: Create a new state and push it
666 ******************************************************************************/
669 acpi_ut_create_update_state_and_push (
670 union acpi_operand_object *object,
672 union acpi_generic_state **state_list)
674 union acpi_generic_state *state;
677 ACPI_FUNCTION_ENTRY ();
680 /* Ignore null objects; these are expected */
686 state = acpi_ut_create_update_state (object, action);
688 return (AE_NO_MEMORY);
691 acpi_ut_push_generic_state (state_list, state);
696 /*******************************************************************************
698 * FUNCTION: acpi_ut_walk_package_tree
700 * PARAMETERS: source_object - The package to walk
701 * target_object - Target object (if package is being copied)
702 * walk_callback - Called once for each package element
703 * Context - Passed to the callback function
707 * DESCRIPTION: Walk through a package
709 ******************************************************************************/
712 acpi_ut_walk_package_tree (
713 union acpi_operand_object *source_object,
715 acpi_pkg_callback walk_callback,
718 acpi_status status = AE_OK;
719 union acpi_generic_state *state_list = NULL;
720 union acpi_generic_state *state;
722 union acpi_operand_object *this_source_obj;
725 ACPI_FUNCTION_TRACE ("ut_walk_package_tree");
728 state = acpi_ut_create_pkg_state (source_object, target_object, 0);
730 return_ACPI_STATUS (AE_NO_MEMORY);
734 /* Get one element of the package */
736 this_index = state->pkg.index;
737 this_source_obj = (union acpi_operand_object *)
738 state->pkg.source_object->package.elements[this_index];
742 * 1) An uninitialized package element. It is completely
743 * legal to declare a package and leave it uninitialized
744 * 2) Not an internal object - can be a namespace node instead
745 * 3) Any type other than a package. Packages are handled in else
748 if ((!this_source_obj) ||
749 (ACPI_GET_DESCRIPTOR_TYPE (this_source_obj) != ACPI_DESC_TYPE_OPERAND) ||
750 (ACPI_GET_OBJECT_TYPE (this_source_obj) != ACPI_TYPE_PACKAGE)) {
751 status = walk_callback (ACPI_COPY_TYPE_SIMPLE, this_source_obj,
753 if (ACPI_FAILURE (status)) {
754 return_ACPI_STATUS (status);
758 while (state->pkg.index >= state->pkg.source_object->package.count) {
760 * We've handled all of the objects at this level, This means
761 * that we have just completed a package. That package may
762 * have contained one or more packages itself.
764 * Delete this state and pop the previous state (package).
766 acpi_ut_delete_generic_state (state);
767 state = acpi_ut_pop_generic_state (&state_list);
769 /* Finished when there are no more states */
773 * We have handled all of the objects in the top level
774 * package just add the length of the package objects
777 return_ACPI_STATUS (AE_OK);
781 * Go back up a level and move the index past the just
782 * completed package object.
788 /* This is a subobject of type package */
790 status = walk_callback (ACPI_COPY_TYPE_PACKAGE, this_source_obj,
792 if (ACPI_FAILURE (status)) {
793 return_ACPI_STATUS (status);
797 * Push the current state and create a new one
798 * The callback above returned a new target package object.
800 acpi_ut_push_generic_state (&state_list, state);
801 state = acpi_ut_create_pkg_state (this_source_obj,
802 state->pkg.this_target_obj, 0);
804 return_ACPI_STATUS (AE_NO_MEMORY);
809 /* We should never get here */
811 return_ACPI_STATUS (AE_AML_INTERNAL);
815 /*******************************************************************************
817 * FUNCTION: acpi_ut_generate_checksum
819 * PARAMETERS: Buffer - Buffer to be scanned
820 * Length - number of bytes to examine
822 * RETURN: The generated checksum
824 * DESCRIPTION: Generate a checksum on a raw buffer
826 ******************************************************************************/
829 acpi_ut_generate_checksum (
837 for (i = 0; i < length; i++) {
838 sum = (signed char) (sum + buffer[i]);
841 return ((u8) (0 - sum));
845 /*******************************************************************************
847 * FUNCTION: acpi_ut_get_resource_end_tag
849 * PARAMETERS: obj_desc - The resource template buffer object
851 * RETURN: Pointer to the end tag
853 * DESCRIPTION: Find the END_TAG resource descriptor in a resource template
855 ******************************************************************************/
859 acpi_ut_get_resource_end_tag (
860 union acpi_operand_object *obj_desc)
867 buffer = obj_desc->buffer.pointer;
868 end_buffer = buffer + obj_desc->buffer.length;
870 while (buffer < end_buffer) {
871 buffer_byte = *buffer;
872 if (buffer_byte & ACPI_RDESC_TYPE_MASK) {
873 /* Large Descriptor - Length is next 2 bytes */
875 buffer += ((*(buffer+1) | (*(buffer+2) << 8)) + 3);
878 /* Small Descriptor. End Tag will be found here */
880 if ((buffer_byte & ACPI_RDESC_SMALL_MASK) == ACPI_RDESC_TYPE_END_TAG) {
881 /* Found the end tag descriptor, all done. */
886 /* Length is in the header */
888 buffer += ((buffer_byte & 0x07) + 1);
892 /* End tag not found */
898 /*******************************************************************************
900 * FUNCTION: acpi_ut_report_error
902 * PARAMETERS: module_name - Caller's module name (for error output)
903 * line_number - Caller's line number (for error output)
904 * component_id - Caller's component ID (for error output)
908 * DESCRIPTION: Print error message
910 ******************************************************************************/
913 acpi_ut_report_error (
919 acpi_os_printf ("%8s-%04d: *** Error: ", module_name, line_number);
923 /*******************************************************************************
925 * FUNCTION: acpi_ut_report_warning
927 * PARAMETERS: module_name - Caller's module name (for error output)
928 * line_number - Caller's line number (for error output)
929 * component_id - Caller's component ID (for error output)
933 * DESCRIPTION: Print warning message
935 ******************************************************************************/
938 acpi_ut_report_warning (
944 acpi_os_printf ("%8s-%04d: *** Warning: ", module_name, line_number);
948 /*******************************************************************************
950 * FUNCTION: acpi_ut_report_info
952 * PARAMETERS: module_name - Caller's module name (for error output)
953 * line_number - Caller's line number (for error output)
954 * component_id - Caller's component ID (for error output)
958 * DESCRIPTION: Print information message
960 ******************************************************************************/
963 acpi_ut_report_info (
969 acpi_os_printf ("%8s-%04d: *** Info: ", module_name, line_number);