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.
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)
68 ACPI_FUNCTION_TRACE("ut_allocate_owner_id");
70 /* Mutex for the global ID mask */
72 status = acpi_ut_acquire_mutex(ACPI_MTX_CACHES);
73 if (ACPI_FAILURE(status)) {
74 return_ACPI_STATUS(status);
77 /* Find a free owner ID */
79 for (i = 0; i < 32; i++) {
80 if (!(acpi_gbl_owner_id_mask & (1 << i))) {
81 acpi_gbl_owner_id_mask |= (1 << i);
82 *owner_id = (acpi_owner_id) (i + 1);
88 * If we are here, all owner_ids have been allocated. This probably should
89 * not happen since the IDs are reused after deallocation. The IDs are
90 * allocated upon table load (one per table) and method execution, and
91 * they are released when a table is unloaded or a method completes
95 status = AE_OWNER_ID_LIMIT;
96 ACPI_REPORT_ERROR(("Could not allocate new owner_id (32 max), AE_OWNER_ID_LIMIT\n"));
99 (void)acpi_ut_release_mutex(ACPI_MTX_CACHES);
100 return_ACPI_STATUS(status);
103 /*******************************************************************************
105 * FUNCTION: acpi_ut_release_owner_id
107 * PARAMETERS: owner_id_ptr - Pointer to a previously allocated owner_iD
109 * RETURN: None. No error is returned because we are either exiting a
110 * control method or unloading a table. Either way, we would
111 * ignore any error anyway.
113 * DESCRIPTION: Release a table or method owner ID. Valid IDs are 1 - 32
115 ******************************************************************************/
117 void acpi_ut_release_owner_id(acpi_owner_id * owner_id_ptr)
119 acpi_owner_id owner_id = *owner_id_ptr;
122 ACPI_FUNCTION_TRACE("ut_release_owner_id");
124 /* Always clear the input owner_id (zero is an invalid ID) */
128 /* Zero is not a valid owner_iD */
130 if ((owner_id == 0) || (owner_id > 32)) {
131 ACPI_REPORT_ERROR(("Invalid owner_id: %2.2X\n", owner_id));
135 /* Mutex for the global ID mask */
137 status = acpi_ut_acquire_mutex(ACPI_MTX_CACHES);
138 if (ACPI_FAILURE(status)) {
142 owner_id--; /* Normalize to zero */
144 /* Free the owner ID only if it is valid */
146 if (acpi_gbl_owner_id_mask & (1 << owner_id)) {
147 acpi_gbl_owner_id_mask ^= (1 << owner_id);
150 (void)acpi_ut_release_mutex(ACPI_MTX_CACHES);
154 /*******************************************************************************
156 * FUNCTION: acpi_ut_strupr (strupr)
158 * PARAMETERS: src_string - The source string to convert
162 * DESCRIPTION: Convert string to uppercase
164 * NOTE: This is not a POSIX function, so it appears here, not in utclib.c
166 ******************************************************************************/
168 void acpi_ut_strupr(char *src_string)
172 ACPI_FUNCTION_ENTRY();
178 /* Walk entire string, uppercasing the letters */
180 for (string = src_string; *string; string++) {
181 *string = (char)ACPI_TOUPPER(*string);
187 /*******************************************************************************
189 * FUNCTION: acpi_ut_print_string
191 * PARAMETERS: String - Null terminated ASCII string
192 * max_length - Maximum output length
196 * DESCRIPTION: Dump an ASCII string with support for ACPI-defined escape
199 ******************************************************************************/
201 void acpi_ut_print_string(char *string, u8 max_length)
206 acpi_os_printf("<\"NULL STRING PTR\">");
210 acpi_os_printf("\"");
211 for (i = 0; string[i] && (i < max_length); i++) {
212 /* Escape sequences */
216 acpi_os_printf("\\a"); /* BELL */
220 acpi_os_printf("\\b"); /* BACKSPACE */
224 acpi_os_printf("\\f"); /* FORMFEED */
228 acpi_os_printf("\\n"); /* LINEFEED */
232 acpi_os_printf("\\r"); /* CARRIAGE RETURN */
236 acpi_os_printf("\\t"); /* HORIZONTAL TAB */
240 acpi_os_printf("\\v"); /* VERTICAL TAB */
243 case '\'': /* Single Quote */
244 case '\"': /* Double Quote */
245 case '\\': /* Backslash */
246 acpi_os_printf("\\%c", (int)string[i]);
251 /* Check for printable character or hex escape */
253 if (ACPI_IS_PRINT(string[i])) {
254 /* This is a normal character */
256 acpi_os_printf("%c", (int)string[i]);
258 /* All others will be Hex escapes */
260 acpi_os_printf("\\x%2.2X", (s32) string[i]);
265 acpi_os_printf("\"");
267 if (i == max_length && string[i]) {
268 acpi_os_printf("...");
272 /*******************************************************************************
274 * FUNCTION: acpi_ut_dword_byte_swap
276 * PARAMETERS: Value - Value to be converted
278 * RETURN: u32 integer with bytes swapped
280 * DESCRIPTION: Convert a 32-bit value to big-endian (swap the bytes)
282 ******************************************************************************/
284 u32 acpi_ut_dword_byte_swap(u32 value)
295 ACPI_FUNCTION_ENTRY();
299 out.bytes[0] = in.bytes[3];
300 out.bytes[1] = in.bytes[2];
301 out.bytes[2] = in.bytes[1];
302 out.bytes[3] = in.bytes[0];
307 /*******************************************************************************
309 * FUNCTION: acpi_ut_set_integer_width
311 * PARAMETERS: Revision From DSDT header
315 * DESCRIPTION: Set the global integer bit width based upon the revision
316 * of the DSDT. For Revision 1 and 0, Integers are 32 bits.
317 * For Revision 2 and above, Integers are 64 bits. Yes, this
318 * makes a difference.
320 ******************************************************************************/
322 void acpi_ut_set_integer_width(u8 revision)
326 acpi_gbl_integer_bit_width = 32;
327 acpi_gbl_integer_nybble_width = 8;
328 acpi_gbl_integer_byte_width = 4;
330 acpi_gbl_integer_bit_width = 64;
331 acpi_gbl_integer_nybble_width = 16;
332 acpi_gbl_integer_byte_width = 8;
336 #ifdef ACPI_DEBUG_OUTPUT
337 /*******************************************************************************
339 * FUNCTION: acpi_ut_display_init_pathname
341 * PARAMETERS: Type - Object type of the node
342 * obj_handle - Handle whose pathname will be displayed
343 * Path - Additional path string to be appended.
344 * (NULL if no extra path)
346 * RETURN: acpi_status
348 * DESCRIPTION: Display full pathname of an object, DEBUG ONLY
350 ******************************************************************************/
353 acpi_ut_display_init_pathname(u8 type,
354 struct acpi_namespace_node *obj_handle,
358 struct acpi_buffer buffer;
360 ACPI_FUNCTION_ENTRY();
362 /* Only print the path if the appropriate debug level is enabled */
364 if (!(acpi_dbg_level & ACPI_LV_INIT_NAMES)) {
368 /* Get the full pathname to the node */
370 buffer.length = ACPI_ALLOCATE_LOCAL_BUFFER;
371 status = acpi_ns_handle_to_pathname(obj_handle, &buffer);
372 if (ACPI_FAILURE(status)) {
376 /* Print what we're doing */
379 case ACPI_TYPE_METHOD:
380 acpi_os_printf("Executing ");
384 acpi_os_printf("Initializing ");
388 /* Print the object type and pathname */
390 acpi_os_printf("%-12s %s",
391 acpi_ut_get_type_name(type), (char *)buffer.pointer);
393 /* Extra path is used to append names like _STA, _INI, etc. */
396 acpi_os_printf(".%s", path);
398 acpi_os_printf("\n");
400 ACPI_MEM_FREE(buffer.pointer);
404 /*******************************************************************************
406 * FUNCTION: acpi_ut_valid_acpi_name
408 * PARAMETERS: Name - The name to be examined
410 * RETURN: TRUE if the name is valid, FALSE otherwise
412 * DESCRIPTION: Check for a valid ACPI name. Each character must be one of:
413 * 1) Upper case alpha
417 ******************************************************************************/
419 u8 acpi_ut_valid_acpi_name(u32 name)
421 char *name_ptr = (char *)&name;
425 ACPI_FUNCTION_ENTRY();
427 for (i = 0; i < ACPI_NAME_SIZE; i++) {
428 character = *name_ptr;
431 if (!((character == '_') ||
432 (character >= 'A' && character <= 'Z') ||
433 (character >= '0' && character <= '9'))) {
441 /*******************************************************************************
443 * FUNCTION: acpi_ut_valid_acpi_character
445 * PARAMETERS: Character - The character to be examined
447 * RETURN: 1 if Character may appear in a name, else 0
449 * DESCRIPTION: Check for a printable character
451 ******************************************************************************/
453 u8 acpi_ut_valid_acpi_character(char character)
456 ACPI_FUNCTION_ENTRY();
458 return ((u8) ((character == '_') ||
459 (character >= 'A' && character <= 'Z') ||
460 (character >= '0' && character <= '9')));
463 /*******************************************************************************
465 * FUNCTION: acpi_ut_strtoul64
467 * PARAMETERS: String - Null terminated string
468 * Base - Radix of the string: 10, 16, or ACPI_ANY_BASE
469 * ret_integer - Where the converted integer is returned
471 * RETURN: Status and Converted value
473 * DESCRIPTION: Convert a string into an unsigned value.
474 * NOTE: Does not support Octal strings, not needed.
476 ******************************************************************************/
479 acpi_ut_strtoul64(char *string, u32 base, acpi_integer * ret_integer)
482 acpi_integer return_value = 0;
483 acpi_integer quotient;
485 ACPI_FUNCTION_TRACE("ut_stroul64");
487 if ((!string) || !(*string)) {
499 return_ACPI_STATUS(AE_BAD_PARAMETER);
502 /* Skip over any white space in the buffer */
504 while (ACPI_IS_SPACE(*string) || *string == '\t') {
509 * If the input parameter Base is zero, then we need to
510 * determine if it is decimal or hexadecimal:
513 if ((*string == '0') && (ACPI_TOLOWER(*(string + 1)) == 'x')) {
522 * For hexadecimal base, skip over the leading
523 * 0 or 0x, if they are present.
526 (*string == '0') && (ACPI_TOLOWER(*(string + 1)) == 'x')) {
530 /* Any string left? */
536 /* Main loop: convert the string to a 64-bit integer */
539 if (ACPI_IS_DIGIT(*string)) {
540 /* Convert ASCII 0-9 to Decimal value */
542 this_digit = ((u8) * string) - '0';
545 /* Digit is out of range */
550 this_digit = (u8) ACPI_TOUPPER(*string);
551 if (ACPI_IS_XDIGIT((char)this_digit)) {
552 /* Convert ASCII Hex char to value */
554 this_digit = this_digit - 'A' + 10;
557 * We allow non-hex chars, just stop now, same as end-of-string.
558 * See ACPI spec, string-to-integer conversion.
564 /* Divide the digit into the correct position */
567 acpi_ut_short_divide((ACPI_INTEGER_MAX -
568 (acpi_integer) this_digit), base,
570 if (return_value > quotient) {
574 return_value *= base;
575 return_value += this_digit;
579 /* All done, normal exit */
581 *ret_integer = return_value;
582 return_ACPI_STATUS(AE_OK);
585 /* Base was set/validated above */
588 return_ACPI_STATUS(AE_BAD_DECIMAL_CONSTANT);
590 return_ACPI_STATUS(AE_BAD_HEX_CONSTANT);
594 /*******************************************************************************
596 * FUNCTION: acpi_ut_create_update_state_and_push
598 * PARAMETERS: Object - Object to be added to the new state
599 * Action - Increment/Decrement
600 * state_list - List the state will be added to
604 * DESCRIPTION: Create a new state and push it
606 ******************************************************************************/
609 acpi_ut_create_update_state_and_push(union acpi_operand_object *object,
611 union acpi_generic_state **state_list)
613 union acpi_generic_state *state;
615 ACPI_FUNCTION_ENTRY();
617 /* Ignore null objects; these are expected */
623 state = acpi_ut_create_update_state(object, action);
625 return (AE_NO_MEMORY);
628 acpi_ut_push_generic_state(state_list, state);
632 /*******************************************************************************
634 * FUNCTION: acpi_ut_walk_package_tree
636 * PARAMETERS: source_object - The package to walk
637 * target_object - Target object (if package is being copied)
638 * walk_callback - Called once for each package element
639 * Context - Passed to the callback function
643 * DESCRIPTION: Walk through a package
645 ******************************************************************************/
648 acpi_ut_walk_package_tree(union acpi_operand_object * source_object,
650 acpi_pkg_callback walk_callback, void *context)
652 acpi_status status = AE_OK;
653 union acpi_generic_state *state_list = NULL;
654 union acpi_generic_state *state;
656 union acpi_operand_object *this_source_obj;
658 ACPI_FUNCTION_TRACE("ut_walk_package_tree");
660 state = acpi_ut_create_pkg_state(source_object, target_object, 0);
662 return_ACPI_STATUS(AE_NO_MEMORY);
666 /* Get one element of the package */
668 this_index = state->pkg.index;
669 this_source_obj = (union acpi_operand_object *)
670 state->pkg.source_object->package.elements[this_index];
674 * 1) An uninitialized package element. It is completely
675 * legal to declare a package and leave it uninitialized
676 * 2) Not an internal object - can be a namespace node instead
677 * 3) Any type other than a package. Packages are handled in else
680 if ((!this_source_obj) ||
681 (ACPI_GET_DESCRIPTOR_TYPE(this_source_obj) !=
682 ACPI_DESC_TYPE_OPERAND)
683 || (ACPI_GET_OBJECT_TYPE(this_source_obj) !=
684 ACPI_TYPE_PACKAGE)) {
686 walk_callback(ACPI_COPY_TYPE_SIMPLE,
687 this_source_obj, state, context);
688 if (ACPI_FAILURE(status)) {
689 return_ACPI_STATUS(status);
693 while (state->pkg.index >=
694 state->pkg.source_object->package.count) {
696 * We've handled all of the objects at this level, This means
697 * that we have just completed a package. That package may
698 * have contained one or more packages itself.
700 * Delete this state and pop the previous state (package).
702 acpi_ut_delete_generic_state(state);
703 state = acpi_ut_pop_generic_state(&state_list);
705 /* Finished when there are no more states */
709 * We have handled all of the objects in the top level
710 * package just add the length of the package objects
713 return_ACPI_STATUS(AE_OK);
717 * Go back up a level and move the index past the just
718 * completed package object.
723 /* This is a subobject of type package */
726 walk_callback(ACPI_COPY_TYPE_PACKAGE,
727 this_source_obj, state, context);
728 if (ACPI_FAILURE(status)) {
729 return_ACPI_STATUS(status);
733 * Push the current state and create a new one
734 * The callback above returned a new target package object.
736 acpi_ut_push_generic_state(&state_list, state);
737 state = acpi_ut_create_pkg_state(this_source_obj,
741 return_ACPI_STATUS(AE_NO_MEMORY);
746 /* We should never get here */
748 return_ACPI_STATUS(AE_AML_INTERNAL);
751 /*******************************************************************************
753 * FUNCTION: acpi_ut_generate_checksum
755 * PARAMETERS: Buffer - Buffer to be scanned
756 * Length - number of bytes to examine
758 * RETURN: The generated checksum
760 * DESCRIPTION: Generate a checksum on a raw buffer
762 ******************************************************************************/
764 u8 acpi_ut_generate_checksum(u8 * buffer, u32 length)
769 for (i = 0; i < length; i++) {
770 sum = (signed char)(sum + buffer[i]);
773 return ((u8) (0 - sum));
776 /*******************************************************************************
778 * FUNCTION: acpi_ut_get_resource_end_tag
780 * PARAMETERS: obj_desc - The resource template buffer object
782 * RETURN: Pointer to the end tag
784 * DESCRIPTION: Find the END_TAG resource descriptor in a resource template
786 ******************************************************************************/
788 u8 *acpi_ut_get_resource_end_tag(union acpi_operand_object * obj_desc)
794 buffer = obj_desc->buffer.pointer;
795 end_buffer = buffer + obj_desc->buffer.length;
797 while (buffer < end_buffer) {
798 buffer_byte = *buffer;
799 if (buffer_byte & ACPI_RDESC_TYPE_MASK) {
800 /* Large Descriptor - Length is next 2 bytes */
802 buffer += ((*(buffer + 1) | (*(buffer + 2) << 8)) + 3);
804 /* Small Descriptor. End Tag will be found here */
806 if ((buffer_byte & ACPI_RDESC_SMALL_MASK) ==
807 ACPI_RDESC_TYPE_END_TAG) {
808 /* Found the end tag descriptor, all done. */
813 /* Length is in the header */
815 buffer += ((buffer_byte & 0x07) + 1);
819 /* End tag not found */
824 /*******************************************************************************
826 * FUNCTION: acpi_ut_report_error
828 * PARAMETERS: module_name - Caller's module name (for error output)
829 * line_number - Caller's line number (for error output)
830 * component_id - Caller's component ID (for error output)
834 * DESCRIPTION: Print error message
836 ******************************************************************************/
838 void acpi_ut_report_error(char *module_name, u32 line_number, u32 component_id)
841 acpi_os_printf("%8s-%04d: *** Error: ", module_name, line_number);
844 /*******************************************************************************
846 * FUNCTION: acpi_ut_report_warning
848 * PARAMETERS: module_name - Caller's module name (for error output)
849 * line_number - Caller's line number (for error output)
850 * component_id - Caller's component ID (for error output)
854 * DESCRIPTION: Print warning message
856 ******************************************************************************/
859 acpi_ut_report_warning(char *module_name, u32 line_number, u32 component_id)
862 acpi_os_printf("%8s-%04d: *** Warning: ", module_name, line_number);
865 /*******************************************************************************
867 * FUNCTION: acpi_ut_report_info
869 * PARAMETERS: module_name - Caller's module name (for error output)
870 * line_number - Caller's line number (for error output)
871 * component_id - Caller's component ID (for error output)
875 * DESCRIPTION: Print information message
877 ******************************************************************************/
879 void acpi_ut_report_info(char *module_name, u32 line_number, u32 component_id)
882 acpi_os_printf("%8s-%04d: *** Info: ", module_name, line_number);