ACPICA: Major update for acpi_get_object_info external interface
[linux-2.6.git] / drivers / acpi / acpica / utmisc.c
1 /*******************************************************************************
2  *
3  * Module Name: utmisc - common utility procedures
4  *
5  ******************************************************************************/
6
7 /*
8  * Copyright (C) 2000 - 2008, Intel Corp.
9  * All rights reserved.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
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.
25  *
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.
29  *
30  * NO WARRANTY
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.
42  */
43
44 #include <linux/module.h>
45
46 #include <acpi/acpi.h>
47 #include "accommon.h"
48 #include "acnamesp.h"
49
50 #define _COMPONENT          ACPI_UTILITIES
51 ACPI_MODULE_NAME("utmisc")
52
53 /*******************************************************************************
54  *
55  * FUNCTION:    acpi_ut_validate_exception
56  *
57  * PARAMETERS:  Status       - The acpi_status code to be formatted
58  *
59  * RETURN:      A string containing the exception text. NULL if exception is
60  *              not valid.
61  *
62  * DESCRIPTION: This function validates and translates an ACPI exception into
63  *              an ASCII string.
64  *
65  ******************************************************************************/
66 const char *acpi_ut_validate_exception(acpi_status status)
67 {
68         u32 sub_status;
69         const char *exception = NULL;
70
71         ACPI_FUNCTION_ENTRY();
72
73         /*
74          * Status is composed of two parts, a "type" and an actual code
75          */
76         sub_status = (status & ~AE_CODE_MASK);
77
78         switch (status & AE_CODE_MASK) {
79         case AE_CODE_ENVIRONMENTAL:
80
81                 if (sub_status <= AE_CODE_ENV_MAX) {
82                         exception = acpi_gbl_exception_names_env[sub_status];
83                 }
84                 break;
85
86         case AE_CODE_PROGRAMMER:
87
88                 if (sub_status <= AE_CODE_PGM_MAX) {
89                         exception = acpi_gbl_exception_names_pgm[sub_status];
90                 }
91                 break;
92
93         case AE_CODE_ACPI_TABLES:
94
95                 if (sub_status <= AE_CODE_TBL_MAX) {
96                         exception = acpi_gbl_exception_names_tbl[sub_status];
97                 }
98                 break;
99
100         case AE_CODE_AML:
101
102                 if (sub_status <= AE_CODE_AML_MAX) {
103                         exception = acpi_gbl_exception_names_aml[sub_status];
104                 }
105                 break;
106
107         case AE_CODE_CONTROL:
108
109                 if (sub_status <= AE_CODE_CTRL_MAX) {
110                         exception = acpi_gbl_exception_names_ctrl[sub_status];
111                 }
112                 break;
113
114         default:
115                 break;
116         }
117
118         return (ACPI_CAST_PTR(const char, exception));
119 }
120
121 /*******************************************************************************
122  *
123  * FUNCTION:    acpi_ut_is_pci_root_bridge
124  *
125  * PARAMETERS:  Id              - The HID/CID in string format
126  *
127  * RETURN:      TRUE if the Id is a match for a PCI/PCI-Express Root Bridge
128  *
129  * DESCRIPTION: Determine if the input ID is a PCI Root Bridge ID.
130  *
131  ******************************************************************************/
132
133 u8 acpi_ut_is_pci_root_bridge(char *id)
134 {
135
136         /*
137          * Check if this is a PCI root bridge.
138          * ACPI 3.0+: check for a PCI Express root also.
139          */
140         if (!(ACPI_STRCMP(id,
141                           PCI_ROOT_HID_STRING)) ||
142             !(ACPI_STRCMP(id, PCI_EXPRESS_ROOT_HID_STRING))) {
143                 return (TRUE);
144         }
145
146         return (FALSE);
147 }
148
149 /*******************************************************************************
150  *
151  * FUNCTION:    acpi_ut_is_aml_table
152  *
153  * PARAMETERS:  Table               - An ACPI table
154  *
155  * RETURN:      TRUE if table contains executable AML; FALSE otherwise
156  *
157  * DESCRIPTION: Check ACPI Signature for a table that contains AML code.
158  *              Currently, these are DSDT,SSDT,PSDT. All other table types are
159  *              data tables that do not contain AML code.
160  *
161  ******************************************************************************/
162
163 u8 acpi_ut_is_aml_table(struct acpi_table_header *table)
164 {
165
166         /* These are the only tables that contain executable AML */
167
168         if (ACPI_COMPARE_NAME(table->signature, ACPI_SIG_DSDT) ||
169             ACPI_COMPARE_NAME(table->signature, ACPI_SIG_PSDT) ||
170             ACPI_COMPARE_NAME(table->signature, ACPI_SIG_SSDT)) {
171                 return (TRUE);
172         }
173
174         return (FALSE);
175 }
176
177 /*******************************************************************************
178  *
179  * FUNCTION:    acpi_ut_allocate_owner_id
180  *
181  * PARAMETERS:  owner_id        - Where the new owner ID is returned
182  *
183  * RETURN:      Status
184  *
185  * DESCRIPTION: Allocate a table or method owner ID. The owner ID is used to
186  *              track objects created by the table or method, to be deleted
187  *              when the method exits or the table is unloaded.
188  *
189  ******************************************************************************/
190
191 acpi_status acpi_ut_allocate_owner_id(acpi_owner_id * owner_id)
192 {
193         u32 i;
194         u32 j;
195         u32 k;
196         acpi_status status;
197
198         ACPI_FUNCTION_TRACE(ut_allocate_owner_id);
199
200         /* Guard against multiple allocations of ID to the same location */
201
202         if (*owner_id) {
203                 ACPI_ERROR((AE_INFO, "Owner ID [%2.2X] already exists",
204                             *owner_id));
205                 return_ACPI_STATUS(AE_ALREADY_EXISTS);
206         }
207
208         /* Mutex for the global ID mask */
209
210         status = acpi_ut_acquire_mutex(ACPI_MTX_CACHES);
211         if (ACPI_FAILURE(status)) {
212                 return_ACPI_STATUS(status);
213         }
214
215         /*
216          * Find a free owner ID, cycle through all possible IDs on repeated
217          * allocations. (ACPI_NUM_OWNERID_MASKS + 1) because first index may have
218          * to be scanned twice.
219          */
220         for (i = 0, j = acpi_gbl_last_owner_id_index;
221              i < (ACPI_NUM_OWNERID_MASKS + 1); i++, j++) {
222                 if (j >= ACPI_NUM_OWNERID_MASKS) {
223                         j = 0;  /* Wraparound to start of mask array */
224                 }
225
226                 for (k = acpi_gbl_next_owner_id_offset; k < 32; k++) {
227                         if (acpi_gbl_owner_id_mask[j] == ACPI_UINT32_MAX) {
228
229                                 /* There are no free IDs in this mask */
230
231                                 break;
232                         }
233
234                         if (!(acpi_gbl_owner_id_mask[j] & (1 << k))) {
235                                 /*
236                                  * Found a free ID. The actual ID is the bit index plus one,
237                                  * making zero an invalid Owner ID. Save this as the last ID
238                                  * allocated and update the global ID mask.
239                                  */
240                                 acpi_gbl_owner_id_mask[j] |= (1 << k);
241
242                                 acpi_gbl_last_owner_id_index = (u8) j;
243                                 acpi_gbl_next_owner_id_offset = (u8) (k + 1);
244
245                                 /*
246                                  * Construct encoded ID from the index and bit position
247                                  *
248                                  * Note: Last [j].k (bit 255) is never used and is marked
249                                  * permanently allocated (prevents +1 overflow)
250                                  */
251                                 *owner_id =
252                                     (acpi_owner_id) ((k + 1) + ACPI_MUL_32(j));
253
254                                 ACPI_DEBUG_PRINT((ACPI_DB_VALUES,
255                                                   "Allocated OwnerId: %2.2X\n",
256                                                   (unsigned int)*owner_id));
257                                 goto exit;
258                         }
259                 }
260
261                 acpi_gbl_next_owner_id_offset = 0;
262         }
263
264         /*
265          * All owner_ids have been allocated. This typically should
266          * not happen since the IDs are reused after deallocation. The IDs are
267          * allocated upon table load (one per table) and method execution, and
268          * they are released when a table is unloaded or a method completes
269          * execution.
270          *
271          * If this error happens, there may be very deep nesting of invoked control
272          * methods, or there may be a bug where the IDs are not released.
273          */
274         status = AE_OWNER_ID_LIMIT;
275         ACPI_ERROR((AE_INFO,
276                     "Could not allocate new OwnerId (255 max), AE_OWNER_ID_LIMIT"));
277
278       exit:
279         (void)acpi_ut_release_mutex(ACPI_MTX_CACHES);
280         return_ACPI_STATUS(status);
281 }
282
283 /*******************************************************************************
284  *
285  * FUNCTION:    acpi_ut_release_owner_id
286  *
287  * PARAMETERS:  owner_id_ptr        - Pointer to a previously allocated owner_iD
288  *
289  * RETURN:      None. No error is returned because we are either exiting a
290  *              control method or unloading a table. Either way, we would
291  *              ignore any error anyway.
292  *
293  * DESCRIPTION: Release a table or method owner ID.  Valid IDs are 1 - 255
294  *
295  ******************************************************************************/
296
297 void acpi_ut_release_owner_id(acpi_owner_id * owner_id_ptr)
298 {
299         acpi_owner_id owner_id = *owner_id_ptr;
300         acpi_status status;
301         u32 index;
302         u32 bit;
303
304         ACPI_FUNCTION_TRACE_U32(ut_release_owner_id, owner_id);
305
306         /* Always clear the input owner_id (zero is an invalid ID) */
307
308         *owner_id_ptr = 0;
309
310         /* Zero is not a valid owner_iD */
311
312         if (owner_id == 0) {
313                 ACPI_ERROR((AE_INFO, "Invalid OwnerId: %2.2X", owner_id));
314                 return_VOID;
315         }
316
317         /* Mutex for the global ID mask */
318
319         status = acpi_ut_acquire_mutex(ACPI_MTX_CACHES);
320         if (ACPI_FAILURE(status)) {
321                 return_VOID;
322         }
323
324         /* Normalize the ID to zero */
325
326         owner_id--;
327
328         /* Decode ID to index/offset pair */
329
330         index = ACPI_DIV_32(owner_id);
331         bit = 1 << ACPI_MOD_32(owner_id);
332
333         /* Free the owner ID only if it is valid */
334
335         if (acpi_gbl_owner_id_mask[index] & bit) {
336                 acpi_gbl_owner_id_mask[index] ^= bit;
337         } else {
338                 ACPI_ERROR((AE_INFO,
339                             "Release of non-allocated OwnerId: %2.2X",
340                             owner_id + 1));
341         }
342
343         (void)acpi_ut_release_mutex(ACPI_MTX_CACHES);
344         return_VOID;
345 }
346
347 /*******************************************************************************
348  *
349  * FUNCTION:    acpi_ut_strupr (strupr)
350  *
351  * PARAMETERS:  src_string      - The source string to convert
352  *
353  * RETURN:      None
354  *
355  * DESCRIPTION: Convert string to uppercase
356  *
357  * NOTE: This is not a POSIX function, so it appears here, not in utclib.c
358  *
359  ******************************************************************************/
360
361 void acpi_ut_strupr(char *src_string)
362 {
363         char *string;
364
365         ACPI_FUNCTION_ENTRY();
366
367         if (!src_string) {
368                 return;
369         }
370
371         /* Walk entire string, uppercasing the letters */
372
373         for (string = src_string; *string; string++) {
374                 *string = (char)ACPI_TOUPPER(*string);
375         }
376
377         return;
378 }
379
380 /*******************************************************************************
381  *
382  * FUNCTION:    acpi_ut_print_string
383  *
384  * PARAMETERS:  String          - Null terminated ASCII string
385  *              max_length      - Maximum output length
386  *
387  * RETURN:      None
388  *
389  * DESCRIPTION: Dump an ASCII string with support for ACPI-defined escape
390  *              sequences.
391  *
392  ******************************************************************************/
393
394 void acpi_ut_print_string(char *string, u8 max_length)
395 {
396         u32 i;
397
398         if (!string) {
399                 acpi_os_printf("<\"NULL STRING PTR\">");
400                 return;
401         }
402
403         acpi_os_printf("\"");
404         for (i = 0; string[i] && (i < max_length); i++) {
405
406                 /* Escape sequences */
407
408                 switch (string[i]) {
409                 case 0x07:
410                         acpi_os_printf("\\a");  /* BELL */
411                         break;
412
413                 case 0x08:
414                         acpi_os_printf("\\b");  /* BACKSPACE */
415                         break;
416
417                 case 0x0C:
418                         acpi_os_printf("\\f");  /* FORMFEED */
419                         break;
420
421                 case 0x0A:
422                         acpi_os_printf("\\n");  /* LINEFEED */
423                         break;
424
425                 case 0x0D:
426                         acpi_os_printf("\\r");  /* CARRIAGE RETURN */
427                         break;
428
429                 case 0x09:
430                         acpi_os_printf("\\t");  /* HORIZONTAL TAB */
431                         break;
432
433                 case 0x0B:
434                         acpi_os_printf("\\v");  /* VERTICAL TAB */
435                         break;
436
437                 case '\'':      /* Single Quote */
438                 case '\"':      /* Double Quote */
439                 case '\\':      /* Backslash */
440                         acpi_os_printf("\\%c", (int)string[i]);
441                         break;
442
443                 default:
444
445                         /* Check for printable character or hex escape */
446
447                         if (ACPI_IS_PRINT(string[i])) {
448                                 /* This is a normal character */
449
450                                 acpi_os_printf("%c", (int)string[i]);
451                         } else {
452                                 /* All others will be Hex escapes */
453
454                                 acpi_os_printf("\\x%2.2X", (s32) string[i]);
455                         }
456                         break;
457                 }
458         }
459         acpi_os_printf("\"");
460
461         if (i == max_length && string[i]) {
462                 acpi_os_printf("...");
463         }
464 }
465
466 /*******************************************************************************
467  *
468  * FUNCTION:    acpi_ut_dword_byte_swap
469  *
470  * PARAMETERS:  Value           - Value to be converted
471  *
472  * RETURN:      u32 integer with bytes swapped
473  *
474  * DESCRIPTION: Convert a 32-bit value to big-endian (swap the bytes)
475  *
476  ******************************************************************************/
477
478 u32 acpi_ut_dword_byte_swap(u32 value)
479 {
480         union {
481                 u32 value;
482                 u8 bytes[4];
483         } out;
484         union {
485                 u32 value;
486                 u8 bytes[4];
487         } in;
488
489         ACPI_FUNCTION_ENTRY();
490
491         in.value = value;
492
493         out.bytes[0] = in.bytes[3];
494         out.bytes[1] = in.bytes[2];
495         out.bytes[2] = in.bytes[1];
496         out.bytes[3] = in.bytes[0];
497
498         return (out.value);
499 }
500
501 /*******************************************************************************
502  *
503  * FUNCTION:    acpi_ut_set_integer_width
504  *
505  * PARAMETERS:  Revision            From DSDT header
506  *
507  * RETURN:      None
508  *
509  * DESCRIPTION: Set the global integer bit width based upon the revision
510  *              of the DSDT.  For Revision 1 and 0, Integers are 32 bits.
511  *              For Revision 2 and above, Integers are 64 bits.  Yes, this
512  *              makes a difference.
513  *
514  ******************************************************************************/
515
516 void acpi_ut_set_integer_width(u8 revision)
517 {
518
519         if (revision < 2) {
520
521                 /* 32-bit case */
522
523                 acpi_gbl_integer_bit_width = 32;
524                 acpi_gbl_integer_nybble_width = 8;
525                 acpi_gbl_integer_byte_width = 4;
526         } else {
527                 /* 64-bit case (ACPI 2.0+) */
528
529                 acpi_gbl_integer_bit_width = 64;
530                 acpi_gbl_integer_nybble_width = 16;
531                 acpi_gbl_integer_byte_width = 8;
532         }
533 }
534
535 #ifdef ACPI_DEBUG_OUTPUT
536 /*******************************************************************************
537  *
538  * FUNCTION:    acpi_ut_display_init_pathname
539  *
540  * PARAMETERS:  Type                - Object type of the node
541  *              obj_handle          - Handle whose pathname will be displayed
542  *              Path                - Additional path string to be appended.
543  *                                      (NULL if no extra path)
544  *
545  * RETURN:      acpi_status
546  *
547  * DESCRIPTION: Display full pathname of an object, DEBUG ONLY
548  *
549  ******************************************************************************/
550
551 void
552 acpi_ut_display_init_pathname(u8 type,
553                               struct acpi_namespace_node *obj_handle,
554                               char *path)
555 {
556         acpi_status status;
557         struct acpi_buffer buffer;
558
559         ACPI_FUNCTION_ENTRY();
560
561         /* Only print the path if the appropriate debug level is enabled */
562
563         if (!(acpi_dbg_level & ACPI_LV_INIT_NAMES)) {
564                 return;
565         }
566
567         /* Get the full pathname to the node */
568
569         buffer.length = ACPI_ALLOCATE_LOCAL_BUFFER;
570         status = acpi_ns_handle_to_pathname(obj_handle, &buffer);
571         if (ACPI_FAILURE(status)) {
572                 return;
573         }
574
575         /* Print what we're doing */
576
577         switch (type) {
578         case ACPI_TYPE_METHOD:
579                 acpi_os_printf("Executing  ");
580                 break;
581
582         default:
583                 acpi_os_printf("Initializing ");
584                 break;
585         }
586
587         /* Print the object type and pathname */
588
589         acpi_os_printf("%-12s %s",
590                        acpi_ut_get_type_name(type), (char *)buffer.pointer);
591
592         /* Extra path is used to append names like _STA, _INI, etc. */
593
594         if (path) {
595                 acpi_os_printf(".%s", path);
596         }
597         acpi_os_printf("\n");
598
599         ACPI_FREE(buffer.pointer);
600 }
601 #endif
602
603 /*******************************************************************************
604  *
605  * FUNCTION:    acpi_ut_valid_acpi_char
606  *
607  * PARAMETERS:  Char            - The character to be examined
608  *              Position        - Byte position (0-3)
609  *
610  * RETURN:      TRUE if the character is valid, FALSE otherwise
611  *
612  * DESCRIPTION: Check for a valid ACPI character. Must be one of:
613  *              1) Upper case alpha
614  *              2) numeric
615  *              3) underscore
616  *
617  *              We allow a '!' as the last character because of the ASF! table
618  *
619  ******************************************************************************/
620
621 u8 acpi_ut_valid_acpi_char(char character, u32 position)
622 {
623
624         if (!((character >= 'A' && character <= 'Z') ||
625               (character >= '0' && character <= '9') || (character == '_'))) {
626
627                 /* Allow a '!' in the last position */
628
629                 if (character == '!' && position == 3) {
630                         return (TRUE);
631                 }
632
633                 return (FALSE);
634         }
635
636         return (TRUE);
637 }
638
639 /*******************************************************************************
640  *
641  * FUNCTION:    acpi_ut_valid_acpi_name
642  *
643  * PARAMETERS:  Name            - The name to be examined
644  *
645  * RETURN:      TRUE if the name is valid, FALSE otherwise
646  *
647  * DESCRIPTION: Check for a valid ACPI name.  Each character must be one of:
648  *              1) Upper case alpha
649  *              2) numeric
650  *              3) underscore
651  *
652  ******************************************************************************/
653
654 u8 acpi_ut_valid_acpi_name(u32 name)
655 {
656         u32 i;
657
658         ACPI_FUNCTION_ENTRY();
659
660         for (i = 0; i < ACPI_NAME_SIZE; i++) {
661                 if (!acpi_ut_valid_acpi_char
662                     ((ACPI_CAST_PTR(char, &name))[i], i)) {
663                         return (FALSE);
664                 }
665         }
666
667         return (TRUE);
668 }
669
670 /*******************************************************************************
671  *
672  * FUNCTION:    acpi_ut_repair_name
673  *
674  * PARAMETERS:  Name            - The ACPI name to be repaired
675  *
676  * RETURN:      Repaired version of the name
677  *
678  * DESCRIPTION: Repair an ACPI name: Change invalid characters to '*' and
679  *              return the new name.
680  *
681  ******************************************************************************/
682
683 acpi_name acpi_ut_repair_name(char *name)
684 {
685        u32 i;
686         char new_name[ACPI_NAME_SIZE];
687
688         for (i = 0; i < ACPI_NAME_SIZE; i++) {
689                 new_name[i] = name[i];
690
691                 /*
692                  * Replace a bad character with something printable, yet technically
693                  * still invalid. This prevents any collisions with existing "good"
694                  * names in the namespace.
695                  */
696                 if (!acpi_ut_valid_acpi_char(name[i], i)) {
697                         new_name[i] = '*';
698                 }
699         }
700
701         return (*(u32 *) new_name);
702 }
703
704 /*******************************************************************************
705  *
706  * FUNCTION:    acpi_ut_strtoul64
707  *
708  * PARAMETERS:  String          - Null terminated string
709  *              Base            - Radix of the string: 16 or ACPI_ANY_BASE;
710  *                                ACPI_ANY_BASE means 'in behalf of to_integer'
711  *              ret_integer     - Where the converted integer is returned
712  *
713  * RETURN:      Status and Converted value
714  *
715  * DESCRIPTION: Convert a string into an unsigned value. Performs either a
716  *              32-bit or 64-bit conversion, depending on the current mode
717  *              of the interpreter.
718  *              NOTE: Does not support Octal strings, not needed.
719  *
720  ******************************************************************************/
721
722 acpi_status
723 acpi_ut_strtoul64(char *string, u32 base, acpi_integer * ret_integer)
724 {
725         u32 this_digit = 0;
726         acpi_integer return_value = 0;
727         acpi_integer quotient;
728         acpi_integer dividend;
729         u32 to_integer_op = (base == ACPI_ANY_BASE);
730         u32 mode32 = (acpi_gbl_integer_byte_width == 4);
731         u8 valid_digits = 0;
732         u8 sign_of0x = 0;
733         u8 term = 0;
734
735         ACPI_FUNCTION_TRACE_STR(ut_stroul64, string);
736
737         switch (base) {
738         case ACPI_ANY_BASE:
739         case 16:
740                 break;
741
742         default:
743                 /* Invalid Base */
744                 return_ACPI_STATUS(AE_BAD_PARAMETER);
745         }
746
747         if (!string) {
748                 goto error_exit;
749         }
750
751         /* Skip over any white space in the buffer */
752
753         while ((*string) && (ACPI_IS_SPACE(*string) || *string == '\t')) {
754                 string++;
755         }
756
757         if (to_integer_op) {
758                 /*
759                  * Base equal to ACPI_ANY_BASE means 'to_integer operation case'.
760                  * We need to determine if it is decimal or hexadecimal.
761                  */
762                 if ((*string == '0') && (ACPI_TOLOWER(*(string + 1)) == 'x')) {
763                         sign_of0x = 1;
764                         base = 16;
765
766                         /* Skip over the leading '0x' */
767                         string += 2;
768                 } else {
769                         base = 10;
770                 }
771         }
772
773         /* Any string left? Check that '0x' is not followed by white space. */
774
775         if (!(*string) || ACPI_IS_SPACE(*string) || *string == '\t') {
776                 if (to_integer_op) {
777                         goto error_exit;
778                 } else {
779                         goto all_done;
780                 }
781         }
782
783         /*
784          * Perform a 32-bit or 64-bit conversion, depending upon the current
785          * execution mode of the interpreter
786          */
787         dividend = (mode32) ? ACPI_UINT32_MAX : ACPI_UINT64_MAX;
788
789         /* Main loop: convert the string to a 32- or 64-bit integer */
790
791         while (*string) {
792                 if (ACPI_IS_DIGIT(*string)) {
793
794                         /* Convert ASCII 0-9 to Decimal value */
795
796                         this_digit = ((u8) * string) - '0';
797                 } else if (base == 10) {
798
799                         /* Digit is out of range; possible in to_integer case only */
800
801                         term = 1;
802                 } else {
803                         this_digit = (u8) ACPI_TOUPPER(*string);
804                         if (ACPI_IS_XDIGIT((char)this_digit)) {
805
806                                 /* Convert ASCII Hex char to value */
807
808                                 this_digit = this_digit - 'A' + 10;
809                         } else {
810                                 term = 1;
811                         }
812                 }
813
814                 if (term) {
815                         if (to_integer_op) {
816                                 goto error_exit;
817                         } else {
818                                 break;
819                         }
820                 } else if ((valid_digits == 0) && (this_digit == 0)
821                            && !sign_of0x) {
822
823                         /* Skip zeros */
824                         string++;
825                         continue;
826                 }
827
828                 valid_digits++;
829
830                 if (sign_of0x && ((valid_digits > 16)
831                                   || ((valid_digits > 8) && mode32))) {
832                         /*
833                          * This is to_integer operation case.
834                          * No any restrictions for string-to-integer conversion,
835                          * see ACPI spec.
836                          */
837                         goto error_exit;
838                 }
839
840                 /* Divide the digit into the correct position */
841
842                 (void)
843                     acpi_ut_short_divide((dividend - (acpi_integer) this_digit),
844                                          base, &quotient, NULL);
845
846                 if (return_value > quotient) {
847                         if (to_integer_op) {
848                                 goto error_exit;
849                         } else {
850                                 break;
851                         }
852                 }
853
854                 return_value *= base;
855                 return_value += this_digit;
856                 string++;
857         }
858
859         /* All done, normal exit */
860
861       all_done:
862
863         ACPI_DEBUG_PRINT((ACPI_DB_EXEC, "Converted value: %8.8X%8.8X\n",
864                           ACPI_FORMAT_UINT64(return_value)));
865
866         *ret_integer = return_value;
867         return_ACPI_STATUS(AE_OK);
868
869       error_exit:
870         /* Base was set/validated above */
871
872         if (base == 10) {
873                 return_ACPI_STATUS(AE_BAD_DECIMAL_CONSTANT);
874         } else {
875                 return_ACPI_STATUS(AE_BAD_HEX_CONSTANT);
876         }
877 }
878
879 /*******************************************************************************
880  *
881  * FUNCTION:    acpi_ut_create_update_state_and_push
882  *
883  * PARAMETERS:  Object          - Object to be added to the new state
884  *              Action          - Increment/Decrement
885  *              state_list      - List the state will be added to
886  *
887  * RETURN:      Status
888  *
889  * DESCRIPTION: Create a new state and push it
890  *
891  ******************************************************************************/
892
893 acpi_status
894 acpi_ut_create_update_state_and_push(union acpi_operand_object *object,
895                                      u16 action,
896                                      union acpi_generic_state **state_list)
897 {
898         union acpi_generic_state *state;
899
900         ACPI_FUNCTION_ENTRY();
901
902         /* Ignore null objects; these are expected */
903
904         if (!object) {
905                 return (AE_OK);
906         }
907
908         state = acpi_ut_create_update_state(object, action);
909         if (!state) {
910                 return (AE_NO_MEMORY);
911         }
912
913         acpi_ut_push_generic_state(state_list, state);
914         return (AE_OK);
915 }
916
917 /*******************************************************************************
918  *
919  * FUNCTION:    acpi_ut_walk_package_tree
920  *
921  * PARAMETERS:  source_object       - The package to walk
922  *              target_object       - Target object (if package is being copied)
923  *              walk_callback       - Called once for each package element
924  *              Context             - Passed to the callback function
925  *
926  * RETURN:      Status
927  *
928  * DESCRIPTION: Walk through a package
929  *
930  ******************************************************************************/
931
932 acpi_status
933 acpi_ut_walk_package_tree(union acpi_operand_object * source_object,
934                           void *target_object,
935                           acpi_pkg_callback walk_callback, void *context)
936 {
937         acpi_status status = AE_OK;
938         union acpi_generic_state *state_list = NULL;
939         union acpi_generic_state *state;
940         u32 this_index;
941         union acpi_operand_object *this_source_obj;
942
943         ACPI_FUNCTION_TRACE(ut_walk_package_tree);
944
945         state = acpi_ut_create_pkg_state(source_object, target_object, 0);
946         if (!state) {
947                 return_ACPI_STATUS(AE_NO_MEMORY);
948         }
949
950         while (state) {
951
952                 /* Get one element of the package */
953
954                 this_index = state->pkg.index;
955                 this_source_obj = (union acpi_operand_object *)
956                     state->pkg.source_object->package.elements[this_index];
957
958                 /*
959                  * Check for:
960                  * 1) An uninitialized package element.  It is completely
961                  *    legal to declare a package and leave it uninitialized
962                  * 2) Not an internal object - can be a namespace node instead
963                  * 3) Any type other than a package.  Packages are handled in else
964                  *    case below.
965                  */
966                 if ((!this_source_obj) ||
967                     (ACPI_GET_DESCRIPTOR_TYPE(this_source_obj) !=
968                      ACPI_DESC_TYPE_OPERAND)
969                     || (this_source_obj->common.type != ACPI_TYPE_PACKAGE)) {
970                         status =
971                             walk_callback(ACPI_COPY_TYPE_SIMPLE,
972                                           this_source_obj, state, context);
973                         if (ACPI_FAILURE(status)) {
974                                 return_ACPI_STATUS(status);
975                         }
976
977                         state->pkg.index++;
978                         while (state->pkg.index >=
979                                state->pkg.source_object->package.count) {
980                                 /*
981                                  * We've handled all of the objects at this level,  This means
982                                  * that we have just completed a package.  That package may
983                                  * have contained one or more packages itself.
984                                  *
985                                  * Delete this state and pop the previous state (package).
986                                  */
987                                 acpi_ut_delete_generic_state(state);
988                                 state = acpi_ut_pop_generic_state(&state_list);
989
990                                 /* Finished when there are no more states */
991
992                                 if (!state) {
993                                         /*
994                                          * We have handled all of the objects in the top level
995                                          * package just add the length of the package objects
996                                          * and exit
997                                          */
998                                         return_ACPI_STATUS(AE_OK);
999                                 }
1000
1001                                 /*
1002                                  * Go back up a level and move the index past the just
1003                                  * completed package object.
1004                                  */
1005                                 state->pkg.index++;
1006                         }
1007                 } else {
1008                         /* This is a subobject of type package */
1009
1010                         status =
1011                             walk_callback(ACPI_COPY_TYPE_PACKAGE,
1012                                           this_source_obj, state, context);
1013                         if (ACPI_FAILURE(status)) {
1014                                 return_ACPI_STATUS(status);
1015                         }
1016
1017                         /*
1018                          * Push the current state and create a new one
1019                          * The callback above returned a new target package object.
1020                          */
1021                         acpi_ut_push_generic_state(&state_list, state);
1022                         state = acpi_ut_create_pkg_state(this_source_obj,
1023                                                          state->pkg.
1024                                                          this_target_obj, 0);
1025                         if (!state) {
1026
1027                                 /* Free any stacked Update State objects */
1028
1029                                 while (state_list) {
1030                                         state =
1031                                             acpi_ut_pop_generic_state
1032                                             (&state_list);
1033                                         acpi_ut_delete_generic_state(state);
1034                                 }
1035                                 return_ACPI_STATUS(AE_NO_MEMORY);
1036                         }
1037                 }
1038         }
1039
1040         /* We should never get here */
1041
1042         return_ACPI_STATUS(AE_AML_INTERNAL);
1043 }
1044
1045 /*******************************************************************************
1046  *
1047  * FUNCTION:    acpi_error, acpi_exception, acpi_warning, acpi_info
1048  *
1049  * PARAMETERS:  module_name         - Caller's module name (for error output)
1050  *              line_number         - Caller's line number (for error output)
1051  *              Format              - Printf format string + additional args
1052  *
1053  * RETURN:      None
1054  *
1055  * DESCRIPTION: Print message with module/line/version info
1056  *
1057  ******************************************************************************/
1058
1059 void ACPI_INTERNAL_VAR_XFACE
1060 acpi_error(const char *module_name, u32 line_number, const char *format, ...)
1061 {
1062         va_list args;
1063
1064         acpi_os_printf("ACPI Error: ");
1065
1066         va_start(args, format);
1067         acpi_os_vprintf(format, args);
1068         acpi_os_printf(" %8.8X %s-%u\n", ACPI_CA_VERSION, module_name,
1069                        line_number);
1070         va_end(args);
1071 }
1072
1073 void ACPI_INTERNAL_VAR_XFACE
1074 acpi_exception(const char *module_name,
1075                u32 line_number, acpi_status status, const char *format, ...)
1076 {
1077         va_list args;
1078
1079         acpi_os_printf("ACPI Exception: %s, ", acpi_format_exception(status));
1080
1081         va_start(args, format);
1082         acpi_os_vprintf(format, args);
1083         acpi_os_printf(" %8.8X %s-%u\n", ACPI_CA_VERSION, module_name,
1084                        line_number);
1085         va_end(args);
1086 }
1087
1088 void ACPI_INTERNAL_VAR_XFACE
1089 acpi_warning(const char *module_name, u32 line_number, const char *format, ...)
1090 {
1091         va_list args;
1092
1093         acpi_os_printf("ACPI Warning: ");
1094
1095         va_start(args, format);
1096         acpi_os_vprintf(format, args);
1097         acpi_os_printf(" %8.8X %s-%u\n", ACPI_CA_VERSION, module_name,
1098                        line_number);
1099         va_end(args);
1100 }
1101
1102 void ACPI_INTERNAL_VAR_XFACE
1103 acpi_info(const char *module_name, u32 line_number, const char *format, ...)
1104 {
1105         va_list args;
1106
1107         acpi_os_printf("ACPI: ");
1108
1109         va_start(args, format);
1110         acpi_os_vprintf(format, args);
1111         acpi_os_printf("\n");
1112         va_end(args);
1113 }
1114
1115 ACPI_EXPORT_SYMBOL(acpi_error)
1116 ACPI_EXPORT_SYMBOL(acpi_exception)
1117 ACPI_EXPORT_SYMBOL(acpi_warning)
1118 ACPI_EXPORT_SYMBOL(acpi_info)