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");
72 /* Mutex for the global ID mask */
74 status = acpi_ut_acquire_mutex(ACPI_MTX_CACHES);
75 if (ACPI_FAILURE(status)) {
76 return_ACPI_STATUS(status);
79 /* Find a free owner ID */
81 for (i = 0; i < 32; i++) {
82 if (!(acpi_gbl_owner_id_mask & (1 << i))) {
83 ACPI_DEBUG_PRINT((ACPI_DB_VALUES,
84 "Current owner_id mask: %8.8X New ID: %2.2X\n",
85 acpi_gbl_owner_id_mask, (i + 1)));
87 acpi_gbl_owner_id_mask |= (1 << i);
88 *owner_id = (acpi_owner_id) (i + 1);
94 * If we are here, all owner_ids have been allocated. This probably should
95 * not happen since the IDs are reused after deallocation. The IDs are
96 * allocated upon table load (one per table) and method execution, and
97 * they are released when a table is unloaded or a method completes
101 status = AE_OWNER_ID_LIMIT;
102 ACPI_REPORT_ERROR(("Could not allocate new owner_id (32 max), AE_OWNER_ID_LIMIT\n"));
105 (void)acpi_ut_release_mutex(ACPI_MTX_CACHES);
106 return_ACPI_STATUS(status);
109 /*******************************************************************************
111 * FUNCTION: acpi_ut_release_owner_id
113 * PARAMETERS: owner_id_ptr - Pointer to a previously allocated owner_iD
115 * RETURN: None. No error is returned because we are either exiting a
116 * control method or unloading a table. Either way, we would
117 * ignore any error anyway.
119 * DESCRIPTION: Release a table or method owner ID. Valid IDs are 1 - 32
121 ******************************************************************************/
123 void acpi_ut_release_owner_id(acpi_owner_id * owner_id_ptr)
125 acpi_owner_id owner_id = *owner_id_ptr;
128 ACPI_FUNCTION_TRACE_U32("ut_release_owner_id", owner_id);
130 /* Always clear the input owner_id (zero is an invalid ID) */
134 /* Zero is not a valid owner_iD */
136 if ((owner_id == 0) || (owner_id > 32)) {
137 ACPI_REPORT_ERROR(("Invalid owner_id: %2.2X\n", owner_id));
141 /* Mutex for the global ID mask */
143 status = acpi_ut_acquire_mutex(ACPI_MTX_CACHES);
144 if (ACPI_FAILURE(status)) {
148 owner_id--; /* Normalize to zero */
150 /* Free the owner ID only if it is valid */
152 if (acpi_gbl_owner_id_mask & (1 << owner_id)) {
153 acpi_gbl_owner_id_mask ^= (1 << owner_id);
156 (void)acpi_ut_release_mutex(ACPI_MTX_CACHES);
160 /*******************************************************************************
162 * FUNCTION: acpi_ut_strupr (strupr)
164 * PARAMETERS: src_string - The source string to convert
168 * DESCRIPTION: Convert string to uppercase
170 * NOTE: This is not a POSIX function, so it appears here, not in utclib.c
172 ******************************************************************************/
174 void acpi_ut_strupr(char *src_string)
178 ACPI_FUNCTION_ENTRY();
184 /* Walk entire string, uppercasing the letters */
186 for (string = src_string; *string; string++) {
187 *string = (char)ACPI_TOUPPER(*string);
193 /*******************************************************************************
195 * FUNCTION: acpi_ut_print_string
197 * PARAMETERS: String - Null terminated ASCII string
198 * max_length - Maximum output length
202 * DESCRIPTION: Dump an ASCII string with support for ACPI-defined escape
205 ******************************************************************************/
207 void acpi_ut_print_string(char *string, u8 max_length)
212 acpi_os_printf("<\"NULL STRING PTR\">");
216 acpi_os_printf("\"");
217 for (i = 0; string[i] && (i < max_length); i++) {
218 /* Escape sequences */
222 acpi_os_printf("\\a"); /* BELL */
226 acpi_os_printf("\\b"); /* BACKSPACE */
230 acpi_os_printf("\\f"); /* FORMFEED */
234 acpi_os_printf("\\n"); /* LINEFEED */
238 acpi_os_printf("\\r"); /* CARRIAGE RETURN */
242 acpi_os_printf("\\t"); /* HORIZONTAL TAB */
246 acpi_os_printf("\\v"); /* VERTICAL TAB */
249 case '\'': /* Single Quote */
250 case '\"': /* Double Quote */
251 case '\\': /* Backslash */
252 acpi_os_printf("\\%c", (int)string[i]);
257 /* Check for printable character or hex escape */
259 if (ACPI_IS_PRINT(string[i])) {
260 /* This is a normal character */
262 acpi_os_printf("%c", (int)string[i]);
264 /* All others will be Hex escapes */
266 acpi_os_printf("\\x%2.2X", (s32) string[i]);
271 acpi_os_printf("\"");
273 if (i == max_length && string[i]) {
274 acpi_os_printf("...");
278 /*******************************************************************************
280 * FUNCTION: acpi_ut_dword_byte_swap
282 * PARAMETERS: Value - Value to be converted
284 * RETURN: u32 integer with bytes swapped
286 * DESCRIPTION: Convert a 32-bit value to big-endian (swap the bytes)
288 ******************************************************************************/
290 u32 acpi_ut_dword_byte_swap(u32 value)
301 ACPI_FUNCTION_ENTRY();
305 out.bytes[0] = in.bytes[3];
306 out.bytes[1] = in.bytes[2];
307 out.bytes[2] = in.bytes[1];
308 out.bytes[3] = in.bytes[0];
313 /*******************************************************************************
315 * FUNCTION: acpi_ut_set_integer_width
317 * PARAMETERS: Revision From DSDT header
321 * DESCRIPTION: Set the global integer bit width based upon the revision
322 * of the DSDT. For Revision 1 and 0, Integers are 32 bits.
323 * For Revision 2 and above, Integers are 64 bits. Yes, this
324 * makes a difference.
326 ******************************************************************************/
328 void acpi_ut_set_integer_width(u8 revision)
332 acpi_gbl_integer_bit_width = 32;
333 acpi_gbl_integer_nybble_width = 8;
334 acpi_gbl_integer_byte_width = 4;
336 acpi_gbl_integer_bit_width = 64;
337 acpi_gbl_integer_nybble_width = 16;
338 acpi_gbl_integer_byte_width = 8;
342 #ifdef ACPI_DEBUG_OUTPUT
343 /*******************************************************************************
345 * FUNCTION: acpi_ut_display_init_pathname
347 * PARAMETERS: Type - Object type of the node
348 * obj_handle - Handle whose pathname will be displayed
349 * Path - Additional path string to be appended.
350 * (NULL if no extra path)
352 * RETURN: acpi_status
354 * DESCRIPTION: Display full pathname of an object, DEBUG ONLY
356 ******************************************************************************/
359 acpi_ut_display_init_pathname(u8 type,
360 struct acpi_namespace_node *obj_handle,
364 struct acpi_buffer buffer;
366 ACPI_FUNCTION_ENTRY();
368 /* Only print the path if the appropriate debug level is enabled */
370 if (!(acpi_dbg_level & ACPI_LV_INIT_NAMES)) {
374 /* Get the full pathname to the node */
376 buffer.length = ACPI_ALLOCATE_LOCAL_BUFFER;
377 status = acpi_ns_handle_to_pathname(obj_handle, &buffer);
378 if (ACPI_FAILURE(status)) {
382 /* Print what we're doing */
385 case ACPI_TYPE_METHOD:
386 acpi_os_printf("Executing ");
390 acpi_os_printf("Initializing ");
394 /* Print the object type and pathname */
396 acpi_os_printf("%-12s %s",
397 acpi_ut_get_type_name(type), (char *)buffer.pointer);
399 /* Extra path is used to append names like _STA, _INI, etc. */
402 acpi_os_printf(".%s", path);
404 acpi_os_printf("\n");
406 ACPI_MEM_FREE(buffer.pointer);
410 /*******************************************************************************
412 * FUNCTION: acpi_ut_valid_acpi_name
414 * PARAMETERS: Name - The name to be examined
416 * RETURN: TRUE if the name is valid, FALSE otherwise
418 * DESCRIPTION: Check for a valid ACPI name. Each character must be one of:
419 * 1) Upper case alpha
423 ******************************************************************************/
425 u8 acpi_ut_valid_acpi_name(u32 name)
427 char *name_ptr = (char *)&name;
431 ACPI_FUNCTION_ENTRY();
433 for (i = 0; i < ACPI_NAME_SIZE; i++) {
434 character = *name_ptr;
437 if (!((character == '_') ||
438 (character >= 'A' && character <= 'Z') ||
439 (character >= '0' && character <= '9'))) {
447 /*******************************************************************************
449 * FUNCTION: acpi_ut_valid_acpi_character
451 * PARAMETERS: Character - The character to be examined
453 * RETURN: 1 if Character may appear in a name, else 0
455 * DESCRIPTION: Check for a printable character
457 ******************************************************************************/
459 u8 acpi_ut_valid_acpi_character(char character)
462 ACPI_FUNCTION_ENTRY();
464 return ((u8) ((character == '_') ||
465 (character >= 'A' && character <= 'Z') ||
466 (character >= '0' && character <= '9')));
469 /*******************************************************************************
471 * FUNCTION: acpi_ut_strtoul64
473 * PARAMETERS: String - Null terminated string
474 * Base - Radix of the string: 10, 16, or ACPI_ANY_BASE
475 * ret_integer - Where the converted integer is returned
477 * RETURN: Status and Converted value
479 * DESCRIPTION: Convert a string into an unsigned value.
480 * NOTE: Does not support Octal strings, not needed.
482 ******************************************************************************/
485 acpi_ut_strtoul64(char *string, u32 base, acpi_integer * ret_integer)
488 acpi_integer return_value = 0;
489 acpi_integer quotient;
491 ACPI_FUNCTION_TRACE("ut_stroul64");
493 if ((!string) || !(*string)) {
505 return_ACPI_STATUS(AE_BAD_PARAMETER);
508 /* Skip over any white space in the buffer */
510 while (ACPI_IS_SPACE(*string) || *string == '\t') {
515 * If the input parameter Base is zero, then we need to
516 * determine if it is decimal or hexadecimal:
519 if ((*string == '0') && (ACPI_TOLOWER(*(string + 1)) == 'x')) {
528 * For hexadecimal base, skip over the leading
529 * 0 or 0x, if they are present.
532 (*string == '0') && (ACPI_TOLOWER(*(string + 1)) == 'x')) {
536 /* Any string left? */
542 /* Main loop: convert the string to a 64-bit integer */
545 if (ACPI_IS_DIGIT(*string)) {
546 /* Convert ASCII 0-9 to Decimal value */
548 this_digit = ((u8) * string) - '0';
551 /* Digit is out of range */
556 this_digit = (u8) ACPI_TOUPPER(*string);
557 if (ACPI_IS_XDIGIT((char)this_digit)) {
558 /* Convert ASCII Hex char to value */
560 this_digit = this_digit - 'A' + 10;
563 * We allow non-hex chars, just stop now, same as end-of-string.
564 * See ACPI spec, string-to-integer conversion.
570 /* Divide the digit into the correct position */
573 acpi_ut_short_divide((ACPI_INTEGER_MAX -
574 (acpi_integer) this_digit), base,
576 if (return_value > quotient) {
580 return_value *= base;
581 return_value += this_digit;
585 /* All done, normal exit */
587 *ret_integer = return_value;
588 return_ACPI_STATUS(AE_OK);
591 /* Base was set/validated above */
594 return_ACPI_STATUS(AE_BAD_DECIMAL_CONSTANT);
596 return_ACPI_STATUS(AE_BAD_HEX_CONSTANT);
600 /*******************************************************************************
602 * FUNCTION: acpi_ut_create_update_state_and_push
604 * PARAMETERS: Object - Object to be added to the new state
605 * Action - Increment/Decrement
606 * state_list - List the state will be added to
610 * DESCRIPTION: Create a new state and push it
612 ******************************************************************************/
615 acpi_ut_create_update_state_and_push(union acpi_operand_object *object,
617 union acpi_generic_state **state_list)
619 union acpi_generic_state *state;
621 ACPI_FUNCTION_ENTRY();
623 /* Ignore null objects; these are expected */
629 state = acpi_ut_create_update_state(object, action);
631 return (AE_NO_MEMORY);
634 acpi_ut_push_generic_state(state_list, state);
638 /*******************************************************************************
640 * FUNCTION: acpi_ut_walk_package_tree
642 * PARAMETERS: source_object - The package to walk
643 * target_object - Target object (if package is being copied)
644 * walk_callback - Called once for each package element
645 * Context - Passed to the callback function
649 * DESCRIPTION: Walk through a package
651 ******************************************************************************/
654 acpi_ut_walk_package_tree(union acpi_operand_object * source_object,
656 acpi_pkg_callback walk_callback, void *context)
658 acpi_status status = AE_OK;
659 union acpi_generic_state *state_list = NULL;
660 union acpi_generic_state *state;
662 union acpi_operand_object *this_source_obj;
664 ACPI_FUNCTION_TRACE("ut_walk_package_tree");
666 state = acpi_ut_create_pkg_state(source_object, target_object, 0);
668 return_ACPI_STATUS(AE_NO_MEMORY);
672 /* Get one element of the package */
674 this_index = state->pkg.index;
675 this_source_obj = (union acpi_operand_object *)
676 state->pkg.source_object->package.elements[this_index];
680 * 1) An uninitialized package element. It is completely
681 * legal to declare a package and leave it uninitialized
682 * 2) Not an internal object - can be a namespace node instead
683 * 3) Any type other than a package. Packages are handled in else
686 if ((!this_source_obj) ||
687 (ACPI_GET_DESCRIPTOR_TYPE(this_source_obj) !=
688 ACPI_DESC_TYPE_OPERAND)
689 || (ACPI_GET_OBJECT_TYPE(this_source_obj) !=
690 ACPI_TYPE_PACKAGE)) {
692 walk_callback(ACPI_COPY_TYPE_SIMPLE,
693 this_source_obj, state, context);
694 if (ACPI_FAILURE(status)) {
695 return_ACPI_STATUS(status);
699 while (state->pkg.index >=
700 state->pkg.source_object->package.count) {
702 * We've handled all of the objects at this level, This means
703 * that we have just completed a package. That package may
704 * have contained one or more packages itself.
706 * Delete this state and pop the previous state (package).
708 acpi_ut_delete_generic_state(state);
709 state = acpi_ut_pop_generic_state(&state_list);
711 /* Finished when there are no more states */
715 * We have handled all of the objects in the top level
716 * package just add the length of the package objects
719 return_ACPI_STATUS(AE_OK);
723 * Go back up a level and move the index past the just
724 * completed package object.
729 /* This is a subobject of type package */
732 walk_callback(ACPI_COPY_TYPE_PACKAGE,
733 this_source_obj, state, context);
734 if (ACPI_FAILURE(status)) {
735 return_ACPI_STATUS(status);
739 * Push the current state and create a new one
740 * The callback above returned a new target package object.
742 acpi_ut_push_generic_state(&state_list, state);
743 state = acpi_ut_create_pkg_state(this_source_obj,
747 return_ACPI_STATUS(AE_NO_MEMORY);
752 /* We should never get here */
754 return_ACPI_STATUS(AE_AML_INTERNAL);
757 /*******************************************************************************
759 * FUNCTION: acpi_ut_generate_checksum
761 * PARAMETERS: Buffer - Buffer to be scanned
762 * Length - number of bytes to examine
764 * RETURN: The generated checksum
766 * DESCRIPTION: Generate a checksum on a raw buffer
768 ******************************************************************************/
770 u8 acpi_ut_generate_checksum(u8 * buffer, u32 length)
775 for (i = 0; i < length; i++) {
776 sum = (signed char)(sum + buffer[i]);
779 return ((u8) (0 - sum));
782 /*******************************************************************************
784 * FUNCTION: acpi_ut_get_resource_end_tag
786 * PARAMETERS: obj_desc - The resource template buffer object
788 * RETURN: Pointer to the end tag
790 * DESCRIPTION: Find the END_TAG resource descriptor in a resource template
792 ******************************************************************************/
794 u8 *acpi_ut_get_resource_end_tag(union acpi_operand_object * obj_desc)
800 buffer = obj_desc->buffer.pointer;
801 end_buffer = buffer + obj_desc->buffer.length;
803 while (buffer < end_buffer) {
804 buffer_byte = *buffer;
805 if (buffer_byte & ACPI_RDESC_TYPE_MASK) {
806 /* Large Descriptor - Length is next 2 bytes */
808 buffer += ((*(buffer + 1) | (*(buffer + 2) << 8)) + 3);
810 /* Small Descriptor. End Tag will be found here */
812 if ((buffer_byte & ACPI_RDESC_SMALL_MASK) ==
813 ACPI_RDESC_TYPE_END_TAG) {
814 /* Found the end tag descriptor, all done. */
819 /* Length is in the header */
821 buffer += ((buffer_byte & 0x07) + 1);
825 /* End tag not found */
830 /*******************************************************************************
832 * FUNCTION: acpi_ut_report_error
834 * PARAMETERS: module_name - Caller's module name (for error output)
835 * line_number - Caller's line number (for error output)
836 * component_id - Caller's component ID (for error output)
840 * DESCRIPTION: Print error message
842 ******************************************************************************/
844 void acpi_ut_report_error(char *module_name, u32 line_number, u32 component_id)
847 acpi_os_printf("%8s-%04d: *** Error: ", module_name, line_number);
850 /*******************************************************************************
852 * FUNCTION: acpi_ut_report_warning
854 * PARAMETERS: module_name - Caller's module name (for error output)
855 * line_number - Caller's line number (for error output)
856 * component_id - Caller's component ID (for error output)
860 * DESCRIPTION: Print warning message
862 ******************************************************************************/
865 acpi_ut_report_warning(char *module_name, u32 line_number, u32 component_id)
868 acpi_os_printf("%8s-%04d: *** Warning: ", module_name, line_number);
871 /*******************************************************************************
873 * FUNCTION: acpi_ut_report_info
875 * PARAMETERS: module_name - Caller's module name (for error output)
876 * line_number - Caller's line number (for error output)
877 * component_id - Caller's component ID (for error output)
881 * DESCRIPTION: Print information message
883 ******************************************************************************/
885 void acpi_ut_report_info(char *module_name, u32 line_number, u32 component_id)
888 acpi_os_printf("%8s-%04d: *** Info: ", module_name, line_number);