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_ERROR((AE_INFO, "Owner ID [%2.2X] already exists",
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;
147 "Could not allocate new owner_id (255 max), AE_OWNER_ID_LIMIT"));
150 (void)acpi_ut_release_mutex(ACPI_MTX_CACHES);
151 return_ACPI_STATUS(status);
154 /*******************************************************************************
156 * FUNCTION: acpi_ut_release_owner_id
158 * PARAMETERS: owner_id_ptr - Pointer to a previously allocated owner_iD
160 * RETURN: None. No error is returned because we are either exiting a
161 * control method or unloading a table. Either way, we would
162 * ignore any error anyway.
164 * DESCRIPTION: Release a table or method owner ID. Valid IDs are 1 - 255
166 ******************************************************************************/
168 void acpi_ut_release_owner_id(acpi_owner_id * owner_id_ptr)
170 acpi_owner_id owner_id = *owner_id_ptr;
172 acpi_native_uint index;
175 ACPI_FUNCTION_TRACE_U32("ut_release_owner_id", owner_id);
177 /* Always clear the input owner_id (zero is an invalid ID) */
181 /* Zero is not a valid owner_iD */
184 ACPI_ERROR((AE_INFO, "Invalid owner_id: %2.2X", owner_id));
188 /* Mutex for the global ID mask */
190 status = acpi_ut_acquire_mutex(ACPI_MTX_CACHES);
191 if (ACPI_FAILURE(status)) {
195 /* Normalize the ID to zero */
199 /* Decode ID to index/offset pair */
201 index = ACPI_DIV_32(owner_id);
202 bit = 1 << ACPI_MOD_32(owner_id);
204 /* Free the owner ID only if it is valid */
206 if (acpi_gbl_owner_id_mask[index] & bit) {
207 acpi_gbl_owner_id_mask[index] ^= bit;
210 "Release of non-allocated owner_id: %2.2X",
214 (void)acpi_ut_release_mutex(ACPI_MTX_CACHES);
218 /*******************************************************************************
220 * FUNCTION: acpi_ut_strupr (strupr)
222 * PARAMETERS: src_string - The source string to convert
226 * DESCRIPTION: Convert string to uppercase
228 * NOTE: This is not a POSIX function, so it appears here, not in utclib.c
230 ******************************************************************************/
232 void acpi_ut_strupr(char *src_string)
236 ACPI_FUNCTION_ENTRY();
242 /* Walk entire string, uppercasing the letters */
244 for (string = src_string; *string; string++) {
245 *string = (char)ACPI_TOUPPER(*string);
251 /*******************************************************************************
253 * FUNCTION: acpi_ut_print_string
255 * PARAMETERS: String - Null terminated ASCII string
256 * max_length - Maximum output length
260 * DESCRIPTION: Dump an ASCII string with support for ACPI-defined escape
263 ******************************************************************************/
265 void acpi_ut_print_string(char *string, u8 max_length)
270 acpi_os_printf("<\"NULL STRING PTR\">");
274 acpi_os_printf("\"");
275 for (i = 0; string[i] && (i < max_length); i++) {
276 /* Escape sequences */
280 acpi_os_printf("\\a"); /* BELL */
284 acpi_os_printf("\\b"); /* BACKSPACE */
288 acpi_os_printf("\\f"); /* FORMFEED */
292 acpi_os_printf("\\n"); /* LINEFEED */
296 acpi_os_printf("\\r"); /* CARRIAGE RETURN */
300 acpi_os_printf("\\t"); /* HORIZONTAL TAB */
304 acpi_os_printf("\\v"); /* VERTICAL TAB */
307 case '\'': /* Single Quote */
308 case '\"': /* Double Quote */
309 case '\\': /* Backslash */
310 acpi_os_printf("\\%c", (int)string[i]);
315 /* Check for printable character or hex escape */
317 if (ACPI_IS_PRINT(string[i])) {
318 /* This is a normal character */
320 acpi_os_printf("%c", (int)string[i]);
322 /* All others will be Hex escapes */
324 acpi_os_printf("\\x%2.2X", (s32) string[i]);
329 acpi_os_printf("\"");
331 if (i == max_length && string[i]) {
332 acpi_os_printf("...");
336 /*******************************************************************************
338 * FUNCTION: acpi_ut_dword_byte_swap
340 * PARAMETERS: Value - Value to be converted
342 * RETURN: u32 integer with bytes swapped
344 * DESCRIPTION: Convert a 32-bit value to big-endian (swap the bytes)
346 ******************************************************************************/
348 u32 acpi_ut_dword_byte_swap(u32 value)
359 ACPI_FUNCTION_ENTRY();
363 out.bytes[0] = in.bytes[3];
364 out.bytes[1] = in.bytes[2];
365 out.bytes[2] = in.bytes[1];
366 out.bytes[3] = in.bytes[0];
371 /*******************************************************************************
373 * FUNCTION: acpi_ut_set_integer_width
375 * PARAMETERS: Revision From DSDT header
379 * DESCRIPTION: Set the global integer bit width based upon the revision
380 * of the DSDT. For Revision 1 and 0, Integers are 32 bits.
381 * For Revision 2 and above, Integers are 64 bits. Yes, this
382 * makes a difference.
384 ******************************************************************************/
386 void acpi_ut_set_integer_width(u8 revision)
390 acpi_gbl_integer_bit_width = 32;
391 acpi_gbl_integer_nybble_width = 8;
392 acpi_gbl_integer_byte_width = 4;
394 acpi_gbl_integer_bit_width = 64;
395 acpi_gbl_integer_nybble_width = 16;
396 acpi_gbl_integer_byte_width = 8;
400 #ifdef ACPI_DEBUG_OUTPUT
401 /*******************************************************************************
403 * FUNCTION: acpi_ut_display_init_pathname
405 * PARAMETERS: Type - Object type of the node
406 * obj_handle - Handle whose pathname will be displayed
407 * Path - Additional path string to be appended.
408 * (NULL if no extra path)
410 * RETURN: acpi_status
412 * DESCRIPTION: Display full pathname of an object, DEBUG ONLY
414 ******************************************************************************/
417 acpi_ut_display_init_pathname(u8 type,
418 struct acpi_namespace_node *obj_handle,
422 struct acpi_buffer buffer;
424 ACPI_FUNCTION_ENTRY();
426 /* Only print the path if the appropriate debug level is enabled */
428 if (!(acpi_dbg_level & ACPI_LV_INIT_NAMES)) {
432 /* Get the full pathname to the node */
434 buffer.length = ACPI_ALLOCATE_LOCAL_BUFFER;
435 status = acpi_ns_handle_to_pathname(obj_handle, &buffer);
436 if (ACPI_FAILURE(status)) {
440 /* Print what we're doing */
443 case ACPI_TYPE_METHOD:
444 acpi_os_printf("Executing ");
448 acpi_os_printf("Initializing ");
452 /* Print the object type and pathname */
454 acpi_os_printf("%-12s %s",
455 acpi_ut_get_type_name(type), (char *)buffer.pointer);
457 /* Extra path is used to append names like _STA, _INI, etc. */
460 acpi_os_printf(".%s", path);
462 acpi_os_printf("\n");
464 ACPI_MEM_FREE(buffer.pointer);
468 /*******************************************************************************
470 * FUNCTION: acpi_ut_valid_acpi_name
472 * PARAMETERS: Name - The name to be examined
474 * RETURN: TRUE if the name is valid, FALSE otherwise
476 * DESCRIPTION: Check for a valid ACPI name. Each character must be one of:
477 * 1) Upper case alpha
481 ******************************************************************************/
483 u8 acpi_ut_valid_acpi_name(u32 name)
485 char *name_ptr = (char *)&name;
489 ACPI_FUNCTION_ENTRY();
491 for (i = 0; i < ACPI_NAME_SIZE; i++) {
492 character = *name_ptr;
495 if (!((character == '_') ||
496 (character >= 'A' && character <= 'Z') ||
497 (character >= '0' && character <= '9'))) {
505 /*******************************************************************************
507 * FUNCTION: acpi_ut_valid_acpi_character
509 * PARAMETERS: Character - The character to be examined
511 * RETURN: 1 if Character may appear in a name, else 0
513 * DESCRIPTION: Check for a printable character
515 ******************************************************************************/
517 u8 acpi_ut_valid_acpi_character(char character)
520 ACPI_FUNCTION_ENTRY();
522 return ((u8) ((character == '_') ||
523 (character >= 'A' && character <= 'Z') ||
524 (character >= '0' && character <= '9')));
527 /*******************************************************************************
529 * FUNCTION: acpi_ut_strtoul64
531 * PARAMETERS: String - Null terminated string
532 * Base - Radix of the string: 10, 16, or ACPI_ANY_BASE
533 * ret_integer - Where the converted integer is returned
535 * RETURN: Status and Converted value
537 * DESCRIPTION: Convert a string into an unsigned value.
538 * NOTE: Does not support Octal strings, not needed.
540 ******************************************************************************/
543 acpi_ut_strtoul64(char *string, u32 base, acpi_integer * ret_integer)
546 acpi_integer return_value = 0;
547 acpi_integer quotient;
549 ACPI_FUNCTION_TRACE("ut_stroul64");
551 if ((!string) || !(*string)) {
563 return_ACPI_STATUS(AE_BAD_PARAMETER);
566 /* Skip over any white space in the buffer */
568 while (ACPI_IS_SPACE(*string) || *string == '\t') {
573 * If the input parameter Base is zero, then we need to
574 * determine if it is decimal or hexadecimal:
577 if ((*string == '0') && (ACPI_TOLOWER(*(string + 1)) == 'x')) {
586 * For hexadecimal base, skip over the leading
587 * 0 or 0x, if they are present.
590 (*string == '0') && (ACPI_TOLOWER(*(string + 1)) == 'x')) {
594 /* Any string left? */
600 /* Main loop: convert the string to a 64-bit integer */
603 if (ACPI_IS_DIGIT(*string)) {
604 /* Convert ASCII 0-9 to Decimal value */
606 this_digit = ((u8) * string) - '0';
609 /* Digit is out of range */
614 this_digit = (u8) ACPI_TOUPPER(*string);
615 if (ACPI_IS_XDIGIT((char)this_digit)) {
616 /* Convert ASCII Hex char to value */
618 this_digit = this_digit - 'A' + 10;
621 * We allow non-hex chars, just stop now, same as end-of-string.
622 * See ACPI spec, string-to-integer conversion.
628 /* Divide the digit into the correct position */
631 acpi_ut_short_divide((ACPI_INTEGER_MAX -
632 (acpi_integer) this_digit), base,
634 if (return_value > quotient) {
638 return_value *= base;
639 return_value += this_digit;
643 /* All done, normal exit */
645 *ret_integer = return_value;
646 return_ACPI_STATUS(AE_OK);
649 /* Base was set/validated above */
652 return_ACPI_STATUS(AE_BAD_DECIMAL_CONSTANT);
654 return_ACPI_STATUS(AE_BAD_HEX_CONSTANT);
658 /*******************************************************************************
660 * FUNCTION: acpi_ut_create_update_state_and_push
662 * PARAMETERS: Object - Object to be added to the new state
663 * Action - Increment/Decrement
664 * state_list - List the state will be added to
668 * DESCRIPTION: Create a new state and push it
670 ******************************************************************************/
673 acpi_ut_create_update_state_and_push(union acpi_operand_object *object,
675 union acpi_generic_state **state_list)
677 union acpi_generic_state *state;
679 ACPI_FUNCTION_ENTRY();
681 /* Ignore null objects; these are expected */
687 state = acpi_ut_create_update_state(object, action);
689 return (AE_NO_MEMORY);
692 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(union acpi_operand_object * source_object,
714 acpi_pkg_callback walk_callback, void *context)
716 acpi_status status = AE_OK;
717 union acpi_generic_state *state_list = NULL;
718 union acpi_generic_state *state;
720 union acpi_operand_object *this_source_obj;
722 ACPI_FUNCTION_TRACE("ut_walk_package_tree");
724 state = acpi_ut_create_pkg_state(source_object, target_object, 0);
726 return_ACPI_STATUS(AE_NO_MEMORY);
730 /* Get one element of the package */
732 this_index = state->pkg.index;
733 this_source_obj = (union acpi_operand_object *)
734 state->pkg.source_object->package.elements[this_index];
738 * 1) An uninitialized package element. It is completely
739 * legal to declare a package and leave it uninitialized
740 * 2) Not an internal object - can be a namespace node instead
741 * 3) Any type other than a package. Packages are handled in else
744 if ((!this_source_obj) ||
745 (ACPI_GET_DESCRIPTOR_TYPE(this_source_obj) !=
746 ACPI_DESC_TYPE_OPERAND)
747 || (ACPI_GET_OBJECT_TYPE(this_source_obj) !=
748 ACPI_TYPE_PACKAGE)) {
750 walk_callback(ACPI_COPY_TYPE_SIMPLE,
751 this_source_obj, state, context);
752 if (ACPI_FAILURE(status)) {
753 return_ACPI_STATUS(status);
757 while (state->pkg.index >=
758 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.
787 /* This is a subobject of type package */
790 walk_callback(ACPI_COPY_TYPE_PACKAGE,
791 this_source_obj, state, context);
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,
805 return_ACPI_STATUS(AE_NO_MEMORY);
810 /* We should never get here */
812 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 ******************************************************************************/
828 u8 acpi_ut_generate_checksum(u8 * buffer, u32 length)
833 for (i = 0; i < length; i++) {
834 sum = (signed char)(sum + buffer[i]);
837 return ((u8) (0 - sum));
840 /*******************************************************************************
842 * FUNCTION: acpi_ut_error, acpi_ut_warning, acpi_ut_info
844 * PARAMETERS: module_name - Caller's module name (for error output)
845 * line_number - Caller's line number (for error output)
846 * Format - Printf format string + additional args
850 * DESCRIPTION: Print message with module/line/version info
852 ******************************************************************************/
854 void ACPI_INTERNAL_VAR_XFACE
855 acpi_ut_error(char *module_name, u32 line_number, char *format, ...)
859 acpi_os_printf("ACPI Error (%s-%04d): ", module_name, line_number);
861 va_start(args, format);
862 acpi_os_vprintf(format, args);
863 acpi_os_printf(" [%X]\n", ACPI_CA_VERSION);
866 void ACPI_INTERNAL_VAR_XFACE
867 acpi_ut_exception(char *module_name,
868 u32 line_number, acpi_status status, char *format, ...)
872 acpi_os_printf("ACPI Exception (%s-%04d): %s, ", module_name,
873 line_number, acpi_format_exception(status));
875 va_start(args, format);
876 acpi_os_vprintf(format, args);
877 acpi_os_printf(" [%X]\n", ACPI_CA_VERSION);
880 void ACPI_INTERNAL_VAR_XFACE
881 acpi_ut_warning(char *module_name, u32 line_number, char *format, ...)
885 acpi_os_printf("ACPI Warning (%s-%04d): ", module_name, line_number);
887 va_start(args, format);
888 acpi_os_vprintf(format, args);
889 acpi_os_printf(" [%X]\n", ACPI_CA_VERSION);
892 void ACPI_INTERNAL_VAR_XFACE
893 acpi_ut_info(char *module_name, u32 line_number, char *format, ...)
897 acpi_os_printf("ACPI (%s-%04d): ", module_name, line_number);
899 va_start(args, format);
900 acpi_os_vprintf(format, args);
901 acpi_os_printf(" [%X]\n", ACPI_CA_VERSION);
904 /*******************************************************************************
906 * FUNCTION: acpi_ut_report_error, Warning, Info
908 * PARAMETERS: module_name - Caller's module name (for error output)
909 * line_number - Caller's line number (for error output)
913 * DESCRIPTION: Print error message
915 * Note: Legacy only, should be removed when no longer used by drivers.
917 ******************************************************************************/
919 void acpi_ut_report_error(char *module_name, u32 line_number)
922 acpi_os_printf("ACPI Error (%s-%04d): ", module_name, line_number);
925 void acpi_ut_report_warning(char *module_name, u32 line_number)
928 acpi_os_printf("ACPI Warning (%s-%04d): ", module_name, line_number);
931 void acpi_ut_report_info(char *module_name, u32 line_number)
934 acpi_os_printf("ACPI (%s-%04d): ", module_name, line_number);