utmisc.c 23.1 KB
Newer Older
Linus Torvalds's avatar
Linus Torvalds committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47
/*******************************************************************************
 *
 * Module Name: utmisc - common utility procedures
 *
 ******************************************************************************/

/*
 * Copyright (C) 2000 - 2005, R. Byron Moore
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions, and the following disclaimer,
 *    without modification.
 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
 *    substantially similar to the "NO WARRANTY" disclaimer below
 *    ("Disclaimer") and any redistribution must be conditioned upon
 *    including a substantially similar Disclaimer requirement for further
 *    binary redistribution.
 * 3. Neither the names of the above-listed copyright holders nor the names
 *    of any contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * Alternatively, this software may be distributed under the terms of the
 * GNU General Public License ("GPL") version 2 as published by the Free
 * Software Foundation.
 *
 * NO WARRANTY
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGES.
 */

#include <acpi/acpi.h>
#include <acpi/acnamesp.h>

#define _COMPONENT          ACPI_UTILITIES
Len Brown's avatar
Len Brown committed
48
ACPI_MODULE_NAME("utmisc")
49

50 51 52 53 54 55
/*******************************************************************************
 *
 * FUNCTION:    acpi_ut_allocate_owner_id
 *
 * PARAMETERS:  owner_id        - Where the new owner ID is returned
 *
56 57 58 59 60
 * RETURN:      Status
 *
 * DESCRIPTION: Allocate a table or method owner ID. The owner ID is used to
 *              track objects created by the table or method, to be deleted
 *              when the method exits or the table is unloaded.
61 62
 *
 ******************************************************************************/
Len Brown's avatar
Len Brown committed
63
acpi_status acpi_ut_allocate_owner_id(acpi_owner_id * owner_id)
64
{
Len Brown's avatar
Len Brown committed
65 66
	acpi_native_uint i;
	acpi_status status;
67

Len Brown's avatar
Len Brown committed
68
	ACPI_FUNCTION_TRACE("ut_allocate_owner_id");
69

Robert Moore's avatar
Robert Moore committed
70 71 72 73 74 75 76 77
	/* Guard against multiple allocations of ID to the same location */

	if (*owner_id) {
		ACPI_REPORT_ERROR(("Owner ID [%2.2X] already exists\n",
				   *owner_id));
		return_ACPI_STATUS(AE_ALREADY_EXISTS);
	}

78 79
	/* Mutex for the global ID mask */

Len Brown's avatar
Len Brown committed
80 81 82
	status = acpi_ut_acquire_mutex(ACPI_MTX_CACHES);
	if (ACPI_FAILURE(status)) {
		return_ACPI_STATUS(status);
83 84 85 86 87 88
	}

	/* Find a free owner ID */

	for (i = 0; i < 32; i++) {
		if (!(acpi_gbl_owner_id_mask & (1 << i))) {
Bob Moore's avatar
Bob Moore committed
89 90
			ACPI_DEBUG_PRINT((ACPI_DB_VALUES,
					  "Current owner_id mask: %8.8X New ID: %2.2X\n",
Robert Moore's avatar
Robert Moore committed
91 92
					  acpi_gbl_owner_id_mask,
					  (unsigned int)(i + 1)));
Bob Moore's avatar
Bob Moore committed
93

94
			acpi_gbl_owner_id_mask |= (1 << i);
95
			*owner_id = (acpi_owner_id) (i + 1);
96 97 98 99 100 101 102 103 104 105 106
			goto exit;
		}
	}

	/*
	 * If we are here, all owner_ids have been allocated. This probably should
	 * not happen since the IDs are reused after deallocation. The IDs are
	 * allocated upon table load (one per table) and method execution, and
	 * they are released when a table is unloaded or a method completes
	 * execution.
	 */
107
	*owner_id = 0;
108
	status = AE_OWNER_ID_LIMIT;
Len Brown's avatar
Len Brown committed
109
	ACPI_REPORT_ERROR(("Could not allocate new owner_id (32 max), AE_OWNER_ID_LIMIT\n"));
110

Len Brown's avatar
Len Brown committed
111 112 113
      exit:
	(void)acpi_ut_release_mutex(ACPI_MTX_CACHES);
	return_ACPI_STATUS(status);
114 115 116 117 118 119
}

/*******************************************************************************
 *
 * FUNCTION:    acpi_ut_release_owner_id
 *
120
 * PARAMETERS:  owner_id_ptr        - Pointer to a previously allocated owner_iD
121
 *
122 123 124 125 126
 * RETURN:      None. No error is returned because we are either exiting a
 *              control method or unloading a table. Either way, we would
 *              ignore any error anyway.
 *
 * DESCRIPTION: Release a table or method owner ID.  Valid IDs are 1 - 32
127 128 129
 *
 ******************************************************************************/

Len Brown's avatar
Len Brown committed
130
void acpi_ut_release_owner_id(acpi_owner_id * owner_id_ptr)
131
{
Len Brown's avatar
Len Brown committed
132 133
	acpi_owner_id owner_id = *owner_id_ptr;
	acpi_status status;
134

Bob Moore's avatar
Bob Moore committed
135
	ACPI_FUNCTION_TRACE_U32("ut_release_owner_id", owner_id);
136

137 138 139 140 141 142 143
	/* Always clear the input owner_id (zero is an invalid ID) */

	*owner_id_ptr = 0;

	/* Zero is not a valid owner_iD */

	if ((owner_id == 0) || (owner_id > 32)) {
Len Brown's avatar
Len Brown committed
144
		ACPI_REPORT_ERROR(("Invalid owner_id: %2.2X\n", owner_id));
145 146 147 148 149
		return_VOID;
	}

	/* Mutex for the global ID mask */

Len Brown's avatar
Len Brown committed
150 151
	status = acpi_ut_acquire_mutex(ACPI_MTX_CACHES);
	if (ACPI_FAILURE(status)) {
152
		return_VOID;
153 154
	}

Robert Moore's avatar
Robert Moore committed
155 156 157
	/* Normalize the ID to zero */

	owner_id--;
158 159

	/* Free the owner ID only if it is valid */
160 161 162 163 164

	if (acpi_gbl_owner_id_mask & (1 << owner_id)) {
		acpi_gbl_owner_id_mask ^= (1 << owner_id);
	}

Len Brown's avatar
Len Brown committed
165
	(void)acpi_ut_release_mutex(ACPI_MTX_CACHES);
166
	return_VOID;
167 168
}

169 170 171 172 173 174
/*******************************************************************************
 *
 * FUNCTION:    acpi_ut_strupr (strupr)
 *
 * PARAMETERS:  src_string      - The source string to convert
 *
175
 * RETURN:      None
176 177 178 179 180 181 182
 *
 * DESCRIPTION: Convert string to uppercase
 *
 * NOTE: This is not a POSIX function, so it appears here, not in utclib.c
 *
 ******************************************************************************/

Len Brown's avatar
Len Brown committed
183
void acpi_ut_strupr(char *src_string)
184
{
Len Brown's avatar
Len Brown committed
185
	char *string;
186

Len Brown's avatar
Len Brown committed
187
	ACPI_FUNCTION_ENTRY();
188

189
	if (!src_string) {
190
		return;
191 192
	}

193 194 195
	/* Walk entire string, uppercasing the letters */

	for (string = src_string; *string; string++) {
Len Brown's avatar
Len Brown committed
196
		*string = (char)ACPI_TOUPPER(*string);
197 198
	}

199
	return;
200 201
}

Linus Torvalds's avatar
Linus Torvalds committed
202 203 204 205 206
/*******************************************************************************
 *
 * FUNCTION:    acpi_ut_print_string
 *
 * PARAMETERS:  String          - Null terminated ASCII string
207
 *              max_length      - Maximum output length
Linus Torvalds's avatar
Linus Torvalds committed
208 209 210 211 212 213 214 215
 *
 * RETURN:      None
 *
 * DESCRIPTION: Dump an ASCII string with support for ACPI-defined escape
 *              sequences.
 *
 ******************************************************************************/

Len Brown's avatar
Len Brown committed
216
void acpi_ut_print_string(char *string, u8 max_length)
Linus Torvalds's avatar
Linus Torvalds committed
217
{
Len Brown's avatar
Len Brown committed
218
	u32 i;
Linus Torvalds's avatar
Linus Torvalds committed
219 220

	if (!string) {
Len Brown's avatar
Len Brown committed
221
		acpi_os_printf("<\"NULL STRING PTR\">");
Linus Torvalds's avatar
Linus Torvalds committed
222 223 224
		return;
	}

Len Brown's avatar
Len Brown committed
225
	acpi_os_printf("\"");
Linus Torvalds's avatar
Linus Torvalds committed
226 227 228 229 230
	for (i = 0; string[i] && (i < max_length); i++) {
		/* Escape sequences */

		switch (string[i]) {
		case 0x07:
Len Brown's avatar
Len Brown committed
231
			acpi_os_printf("\\a");	/* BELL */
Linus Torvalds's avatar
Linus Torvalds committed
232 233 234
			break;

		case 0x08:
Len Brown's avatar
Len Brown committed
235
			acpi_os_printf("\\b");	/* BACKSPACE */
Linus Torvalds's avatar
Linus Torvalds committed
236 237 238
			break;

		case 0x0C:
Len Brown's avatar
Len Brown committed
239
			acpi_os_printf("\\f");	/* FORMFEED */
Linus Torvalds's avatar
Linus Torvalds committed
240 241 242
			break;

		case 0x0A:
Len Brown's avatar
Len Brown committed
243
			acpi_os_printf("\\n");	/* LINEFEED */
Linus Torvalds's avatar
Linus Torvalds committed
244 245 246
			break;

		case 0x0D:
Len Brown's avatar
Len Brown committed
247
			acpi_os_printf("\\r");	/* CARRIAGE RETURN */
Linus Torvalds's avatar
Linus Torvalds committed
248 249 250
			break;

		case 0x09:
Len Brown's avatar
Len Brown committed
251
			acpi_os_printf("\\t");	/* HORIZONTAL TAB */
Linus Torvalds's avatar
Linus Torvalds committed
252 253 254
			break;

		case 0x0B:
Len Brown's avatar
Len Brown committed
255
			acpi_os_printf("\\v");	/* VERTICAL TAB */
Linus Torvalds's avatar
Linus Torvalds committed
256 257
			break;

Len Brown's avatar
Len Brown committed
258 259 260 261
		case '\'':	/* Single Quote */
		case '\"':	/* Double Quote */
		case '\\':	/* Backslash */
			acpi_os_printf("\\%c", (int)string[i]);
Linus Torvalds's avatar
Linus Torvalds committed
262 263 264 265 266 267
			break;

		default:

			/* Check for printable character or hex escape */

Len Brown's avatar
Len Brown committed
268
			if (ACPI_IS_PRINT(string[i])) {
Linus Torvalds's avatar
Linus Torvalds committed
269 270
				/* This is a normal character */

Len Brown's avatar
Len Brown committed
271 272
				acpi_os_printf("%c", (int)string[i]);
			} else {
Linus Torvalds's avatar
Linus Torvalds committed
273 274
				/* All others will be Hex escapes */

Len Brown's avatar
Len Brown committed
275
				acpi_os_printf("\\x%2.2X", (s32) string[i]);
Linus Torvalds's avatar
Linus Torvalds committed
276 277 278 279
			}
			break;
		}
	}
Len Brown's avatar
Len Brown committed
280
	acpi_os_printf("\"");
Linus Torvalds's avatar
Linus Torvalds committed
281 282

	if (i == max_length && string[i]) {
Len Brown's avatar
Len Brown committed
283
		acpi_os_printf("...");
Linus Torvalds's avatar
Linus Torvalds committed
284 285 286 287 288 289 290 291 292
	}
}

/*******************************************************************************
 *
 * FUNCTION:    acpi_ut_dword_byte_swap
 *
 * PARAMETERS:  Value           - Value to be converted
 *
293 294
 * RETURN:      u32 integer with bytes swapped
 *
Linus Torvalds's avatar
Linus Torvalds committed
295 296 297 298
 * DESCRIPTION: Convert a 32-bit value to big-endian (swap the bytes)
 *
 ******************************************************************************/

Len Brown's avatar
Len Brown committed
299
u32 acpi_ut_dword_byte_swap(u32 value)
Linus Torvalds's avatar
Linus Torvalds committed
300 301
{
	union {
Len Brown's avatar
Len Brown committed
302 303
		u32 value;
		u8 bytes[4];
Linus Torvalds's avatar
Linus Torvalds committed
304 305
	} out;
	union {
Len Brown's avatar
Len Brown committed
306 307
		u32 value;
		u8 bytes[4];
Linus Torvalds's avatar
Linus Torvalds committed
308 309
	} in;

Len Brown's avatar
Len Brown committed
310
	ACPI_FUNCTION_ENTRY();
Linus Torvalds's avatar
Linus Torvalds committed
311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336

	in.value = value;

	out.bytes[0] = in.bytes[3];
	out.bytes[1] = in.bytes[2];
	out.bytes[2] = in.bytes[1];
	out.bytes[3] = in.bytes[0];

	return (out.value);
}

/*******************************************************************************
 *
 * FUNCTION:    acpi_ut_set_integer_width
 *
 * PARAMETERS:  Revision            From DSDT header
 *
 * RETURN:      None
 *
 * DESCRIPTION: Set the global integer bit width based upon the revision
 *              of the DSDT.  For Revision 1 and 0, Integers are 32 bits.
 *              For Revision 2 and above, Integers are 64 bits.  Yes, this
 *              makes a difference.
 *
 ******************************************************************************/

Len Brown's avatar
Len Brown committed
337
void acpi_ut_set_integer_width(u8 revision)
Linus Torvalds's avatar
Linus Torvalds committed
338 339 340 341 342 343
{

	if (revision <= 1) {
		acpi_gbl_integer_bit_width = 32;
		acpi_gbl_integer_nybble_width = 8;
		acpi_gbl_integer_byte_width = 4;
Len Brown's avatar
Len Brown committed
344
	} else {
Linus Torvalds's avatar
Linus Torvalds committed
345 346 347 348 349 350 351 352 353 354 355
		acpi_gbl_integer_bit_width = 64;
		acpi_gbl_integer_nybble_width = 16;
		acpi_gbl_integer_byte_width = 8;
	}
}

#ifdef ACPI_DEBUG_OUTPUT
/*******************************************************************************
 *
 * FUNCTION:    acpi_ut_display_init_pathname
 *
356 357
 * PARAMETERS:  Type                - Object type of the node
 *              obj_handle          - Handle whose pathname will be displayed
Linus Torvalds's avatar
Linus Torvalds committed
358 359 360 361 362 363 364 365 366 367
 *              Path                - Additional path string to be appended.
 *                                      (NULL if no extra path)
 *
 * RETURN:      acpi_status
 *
 * DESCRIPTION: Display full pathname of an object, DEBUG ONLY
 *
 ******************************************************************************/

void
Len Brown's avatar
Len Brown committed
368 369 370
acpi_ut_display_init_pathname(u8 type,
			      struct acpi_namespace_node *obj_handle,
			      char *path)
Linus Torvalds's avatar
Linus Torvalds committed
371
{
Len Brown's avatar
Len Brown committed
372 373
	acpi_status status;
	struct acpi_buffer buffer;
Linus Torvalds's avatar
Linus Torvalds committed
374

Len Brown's avatar
Len Brown committed
375
	ACPI_FUNCTION_ENTRY();
Linus Torvalds's avatar
Linus Torvalds committed
376 377 378 379 380 381 382 383 384 385

	/* Only print the path if the appropriate debug level is enabled */

	if (!(acpi_dbg_level & ACPI_LV_INIT_NAMES)) {
		return;
	}

	/* Get the full pathname to the node */

	buffer.length = ACPI_ALLOCATE_LOCAL_BUFFER;
Len Brown's avatar
Len Brown committed
386 387
	status = acpi_ns_handle_to_pathname(obj_handle, &buffer);
	if (ACPI_FAILURE(status)) {
Linus Torvalds's avatar
Linus Torvalds committed
388 389 390 391 392 393 394
		return;
	}

	/* Print what we're doing */

	switch (type) {
	case ACPI_TYPE_METHOD:
Len Brown's avatar
Len Brown committed
395
		acpi_os_printf("Executing  ");
Linus Torvalds's avatar
Linus Torvalds committed
396 397 398
		break;

	default:
Len Brown's avatar
Len Brown committed
399
		acpi_os_printf("Initializing ");
Linus Torvalds's avatar
Linus Torvalds committed
400 401 402 403 404
		break;
	}

	/* Print the object type and pathname */

Len Brown's avatar
Len Brown committed
405 406
	acpi_os_printf("%-12s %s",
		       acpi_ut_get_type_name(type), (char *)buffer.pointer);
Linus Torvalds's avatar
Linus Torvalds committed
407 408 409 410

	/* Extra path is used to append names like _STA, _INI, etc. */

	if (path) {
Len Brown's avatar
Len Brown committed
411
		acpi_os_printf(".%s", path);
Linus Torvalds's avatar
Linus Torvalds committed
412
	}
Len Brown's avatar
Len Brown committed
413
	acpi_os_printf("\n");
Linus Torvalds's avatar
Linus Torvalds committed
414

Len Brown's avatar
Len Brown committed
415
	ACPI_MEM_FREE(buffer.pointer);
Linus Torvalds's avatar
Linus Torvalds committed
416 417 418 419 420 421 422
}
#endif

/*******************************************************************************
 *
 * FUNCTION:    acpi_ut_valid_acpi_name
 *
423
 * PARAMETERS:  Name            - The name to be examined
Linus Torvalds's avatar
Linus Torvalds committed
424
 *
425
 * RETURN:      TRUE if the name is valid, FALSE otherwise
Linus Torvalds's avatar
Linus Torvalds committed
426 427 428 429 430 431 432 433
 *
 * DESCRIPTION: Check for a valid ACPI name.  Each character must be one of:
 *              1) Upper case alpha
 *              2) numeric
 *              3) underscore
 *
 ******************************************************************************/

Len Brown's avatar
Len Brown committed
434
u8 acpi_ut_valid_acpi_name(u32 name)
Linus Torvalds's avatar
Linus Torvalds committed
435
{
Len Brown's avatar
Len Brown committed
436 437 438
	char *name_ptr = (char *)&name;
	char character;
	acpi_native_uint i;
Linus Torvalds's avatar
Linus Torvalds committed
439

Len Brown's avatar
Len Brown committed
440
	ACPI_FUNCTION_ENTRY();
Linus Torvalds's avatar
Linus Torvalds committed
441 442 443 444 445 446

	for (i = 0; i < ACPI_NAME_SIZE; i++) {
		character = *name_ptr;
		name_ptr++;

		if (!((character == '_') ||
Len Brown's avatar
Len Brown committed
447 448
		      (character >= 'A' && character <= 'Z') ||
		      (character >= '0' && character <= '9'))) {
Linus Torvalds's avatar
Linus Torvalds committed
449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467
			return (FALSE);
		}
	}

	return (TRUE);
}

/*******************************************************************************
 *
 * FUNCTION:    acpi_ut_valid_acpi_character
 *
 * PARAMETERS:  Character           - The character to be examined
 *
 * RETURN:      1 if Character may appear in a name, else 0
 *
 * DESCRIPTION: Check for a printable character
 *
 ******************************************************************************/

Len Brown's avatar
Len Brown committed
468
u8 acpi_ut_valid_acpi_character(char character)
Linus Torvalds's avatar
Linus Torvalds committed
469 470
{

Len Brown's avatar
Len Brown committed
471
	ACPI_FUNCTION_ENTRY();
Linus Torvalds's avatar
Linus Torvalds committed
472

Len Brown's avatar
Len Brown committed
473 474 475
	return ((u8) ((character == '_') ||
		      (character >= 'A' && character <= 'Z') ||
		      (character >= '0' && character <= '9')));
Linus Torvalds's avatar
Linus Torvalds committed
476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493
}

/*******************************************************************************
 *
 * FUNCTION:    acpi_ut_strtoul64
 *
 * PARAMETERS:  String          - Null terminated string
 *              Base            - Radix of the string: 10, 16, or ACPI_ANY_BASE
 *              ret_integer     - Where the converted integer is returned
 *
 * RETURN:      Status and Converted value
 *
 * DESCRIPTION: Convert a string into an unsigned value.
 *              NOTE: Does not support Octal strings, not needed.
 *
 ******************************************************************************/

acpi_status
Len Brown's avatar
Len Brown committed
494
acpi_ut_strtoul64(char *string, u32 base, acpi_integer * ret_integer)
Linus Torvalds's avatar
Linus Torvalds committed
495
{
Len Brown's avatar
Len Brown committed
496 497 498
	u32 this_digit = 0;
	acpi_integer return_value = 0;
	acpi_integer quotient;
Linus Torvalds's avatar
Linus Torvalds committed
499

Len Brown's avatar
Len Brown committed
500
	ACPI_FUNCTION_TRACE("ut_stroul64");
Linus Torvalds's avatar
Linus Torvalds committed
501 502 503 504 505 506 507 508 509 510 511 512 513

	if ((!string) || !(*string)) {
		goto error_exit;
	}

	switch (base) {
	case ACPI_ANY_BASE:
	case 10:
	case 16:
		break;

	default:
		/* Invalid Base */
Len Brown's avatar
Len Brown committed
514
		return_ACPI_STATUS(AE_BAD_PARAMETER);
Linus Torvalds's avatar
Linus Torvalds committed
515 516 517 518
	}

	/* Skip over any white space in the buffer */

Len Brown's avatar
Len Brown committed
519
	while (ACPI_IS_SPACE(*string) || *string == '\t') {
Linus Torvalds's avatar
Linus Torvalds committed
520 521 522 523 524 525 526 527
		string++;
	}

	/*
	 * If the input parameter Base is zero, then we need to
	 * determine if it is decimal or hexadecimal:
	 */
	if (base == 0) {
Len Brown's avatar
Len Brown committed
528
		if ((*string == '0') && (ACPI_TOLOWER(*(string + 1)) == 'x')) {
Linus Torvalds's avatar
Linus Torvalds committed
529 530
			base = 16;
			string += 2;
Len Brown's avatar
Len Brown committed
531
		} else {
Linus Torvalds's avatar
Linus Torvalds committed
532 533 534 535 536 537 538 539 540
			base = 10;
		}
	}

	/*
	 * For hexadecimal base, skip over the leading
	 * 0 or 0x, if they are present.
	 */
	if ((base == 16) &&
Len Brown's avatar
Len Brown committed
541
	    (*string == '0') && (ACPI_TOLOWER(*(string + 1)) == 'x')) {
Linus Torvalds's avatar
Linus Torvalds committed
542 543 544 545 546 547 548 549 550 551 552 553
		string += 2;
	}

	/* Any string left? */

	if (!(*string)) {
		goto error_exit;
	}

	/* Main loop: convert the string to a 64-bit integer */

	while (*string) {
Len Brown's avatar
Len Brown committed
554
		if (ACPI_IS_DIGIT(*string)) {
Linus Torvalds's avatar
Linus Torvalds committed
555 556
			/* Convert ASCII 0-9 to Decimal value */

Len Brown's avatar
Len Brown committed
557 558
			this_digit = ((u8) * string) - '0';
		} else {
Linus Torvalds's avatar
Linus Torvalds committed
559 560 561 562 563 564
			if (base == 10) {
				/* Digit is out of range */

				goto error_exit;
			}

Len Brown's avatar
Len Brown committed
565 566
			this_digit = (u8) ACPI_TOUPPER(*string);
			if (ACPI_IS_XDIGIT((char)this_digit)) {
Linus Torvalds's avatar
Linus Torvalds committed
567 568 569
				/* Convert ASCII Hex char to value */

				this_digit = this_digit - 'A' + 10;
Len Brown's avatar
Len Brown committed
570
			} else {
Linus Torvalds's avatar
Linus Torvalds committed
571 572 573 574 575 576 577 578 579 580
				/*
				 * We allow non-hex chars, just stop now, same as end-of-string.
				 * See ACPI spec, string-to-integer conversion.
				 */
				break;
			}
		}

		/* Divide the digit into the correct position */

Len Brown's avatar
Len Brown committed
581 582 583 584
		(void)
		    acpi_ut_short_divide((ACPI_INTEGER_MAX -
					  (acpi_integer) this_digit), base,
					 &quotient, NULL);
Linus Torvalds's avatar
Linus Torvalds committed
585 586 587 588 589 590 591 592 593 594 595 596
		if (return_value > quotient) {
			goto error_exit;
		}

		return_value *= base;
		return_value += this_digit;
		string++;
	}

	/* All done, normal exit */

	*ret_integer = return_value;
Len Brown's avatar
Len Brown committed
597
	return_ACPI_STATUS(AE_OK);
Linus Torvalds's avatar
Linus Torvalds committed
598

Len Brown's avatar
Len Brown committed
599
      error_exit:
Linus Torvalds's avatar
Linus Torvalds committed
600 601 602
	/* Base was set/validated above */

	if (base == 10) {
Len Brown's avatar
Len Brown committed
603 604 605
		return_ACPI_STATUS(AE_BAD_DECIMAL_CONSTANT);
	} else {
		return_ACPI_STATUS(AE_BAD_HEX_CONSTANT);
Linus Torvalds's avatar
Linus Torvalds committed
606 607 608 609 610 611 612
	}
}

/*******************************************************************************
 *
 * FUNCTION:    acpi_ut_create_update_state_and_push
 *
613
 * PARAMETERS:  Object          - Object to be added to the new state
Linus Torvalds's avatar
Linus Torvalds committed
614 615 616
 *              Action          - Increment/Decrement
 *              state_list      - List the state will be added to
 *
617
 * RETURN:      Status
Linus Torvalds's avatar
Linus Torvalds committed
618 619 620 621 622 623
 *
 * DESCRIPTION: Create a new state and push it
 *
 ******************************************************************************/

acpi_status
Len Brown's avatar
Len Brown committed
624 625 626
acpi_ut_create_update_state_and_push(union acpi_operand_object *object,
				     u16 action,
				     union acpi_generic_state **state_list)
Linus Torvalds's avatar
Linus Torvalds committed
627
{
Len Brown's avatar
Len Brown committed
628
	union acpi_generic_state *state;
Linus Torvalds's avatar
Linus Torvalds committed
629

Len Brown's avatar
Len Brown committed
630
	ACPI_FUNCTION_ENTRY();
Linus Torvalds's avatar
Linus Torvalds committed
631 632 633 634 635 636 637

	/* Ignore null objects; these are expected */

	if (!object) {
		return (AE_OK);
	}

Len Brown's avatar
Len Brown committed
638
	state = acpi_ut_create_update_state(object, action);
Linus Torvalds's avatar
Linus Torvalds committed
639 640 641 642
	if (!state) {
		return (AE_NO_MEMORY);
	}

Len Brown's avatar
Len Brown committed
643
	acpi_ut_push_generic_state(state_list, state);
Linus Torvalds's avatar
Linus Torvalds committed
644 645 646 647 648 649 650
	return (AE_OK);
}

/*******************************************************************************
 *
 * FUNCTION:    acpi_ut_walk_package_tree
 *
651 652 653 654
 * PARAMETERS:  source_object       - The package to walk
 *              target_object       - Target object (if package is being copied)
 *              walk_callback       - Called once for each package element
 *              Context             - Passed to the callback function
Linus Torvalds's avatar
Linus Torvalds committed
655 656 657 658 659 660 661 662
 *
 * RETURN:      Status
 *
 * DESCRIPTION: Walk through a package
 *
 ******************************************************************************/

acpi_status
Len Brown's avatar
Len Brown committed
663 664 665
acpi_ut_walk_package_tree(union acpi_operand_object * source_object,
			  void *target_object,
			  acpi_pkg_callback walk_callback, void *context)
Linus Torvalds's avatar
Linus Torvalds committed
666
{
Len Brown's avatar
Len Brown committed
667 668 669 670 671
	acpi_status status = AE_OK;
	union acpi_generic_state *state_list = NULL;
	union acpi_generic_state *state;
	u32 this_index;
	union acpi_operand_object *this_source_obj;
Linus Torvalds's avatar
Linus Torvalds committed
672

Len Brown's avatar
Len Brown committed
673
	ACPI_FUNCTION_TRACE("ut_walk_package_tree");
Linus Torvalds's avatar
Linus Torvalds committed
674

Len Brown's avatar
Len Brown committed
675
	state = acpi_ut_create_pkg_state(source_object, target_object, 0);
Linus Torvalds's avatar
Linus Torvalds committed
676
	if (!state) {
Len Brown's avatar
Len Brown committed
677
		return_ACPI_STATUS(AE_NO_MEMORY);
Linus Torvalds's avatar
Linus Torvalds committed
678 679 680 681 682
	}

	while (state) {
		/* Get one element of the package */

Len Brown's avatar
Len Brown committed
683
		this_index = state->pkg.index;
Linus Torvalds's avatar
Linus Torvalds committed
684
		this_source_obj = (union acpi_operand_object *)
Len Brown's avatar
Len Brown committed
685
		    state->pkg.source_object->package.elements[this_index];
Linus Torvalds's avatar
Linus Torvalds committed
686 687 688 689 690 691 692 693 694 695

		/*
		 * Check for:
		 * 1) An uninitialized package element.  It is completely
		 *    legal to declare a package and leave it uninitialized
		 * 2) Not an internal object - can be a namespace node instead
		 * 3) Any type other than a package.  Packages are handled in else
		 *    case below.
		 */
		if ((!this_source_obj) ||
Len Brown's avatar
Len Brown committed
696 697 698 699 700 701 702 703 704
		    (ACPI_GET_DESCRIPTOR_TYPE(this_source_obj) !=
		     ACPI_DESC_TYPE_OPERAND)
		    || (ACPI_GET_OBJECT_TYPE(this_source_obj) !=
			ACPI_TYPE_PACKAGE)) {
			status =
			    walk_callback(ACPI_COPY_TYPE_SIMPLE,
					  this_source_obj, state, context);
			if (ACPI_FAILURE(status)) {
				return_ACPI_STATUS(status);
Linus Torvalds's avatar
Linus Torvalds committed
705 706 707
			}

			state->pkg.index++;
Len Brown's avatar
Len Brown committed
708 709
			while (state->pkg.index >=
			       state->pkg.source_object->package.count) {
Linus Torvalds's avatar
Linus Torvalds committed
710 711 712 713 714 715 716
				/*
				 * We've handled all of the objects at this level,  This means
				 * that we have just completed a package.  That package may
				 * have contained one or more packages itself.
				 *
				 * Delete this state and pop the previous state (package).
				 */
Len Brown's avatar
Len Brown committed
717 718
				acpi_ut_delete_generic_state(state);
				state = acpi_ut_pop_generic_state(&state_list);
Linus Torvalds's avatar
Linus Torvalds committed
719 720 721 722 723 724 725 726 727

				/* Finished when there are no more states */

				if (!state) {
					/*
					 * We have handled all of the objects in the top level
					 * package just add the length of the package objects
					 * and exit
					 */
Len Brown's avatar
Len Brown committed
728
					return_ACPI_STATUS(AE_OK);
Linus Torvalds's avatar
Linus Torvalds committed
729 730 731 732 733 734 735 736
				}

				/*
				 * Go back up a level and move the index past the just
				 * completed package object.
				 */
				state->pkg.index++;
			}
Len Brown's avatar
Len Brown committed
737
		} else {
Linus Torvalds's avatar
Linus Torvalds committed
738 739
			/* This is a subobject of type package */

Len Brown's avatar
Len Brown committed
740 741 742 743 744
			status =
			    walk_callback(ACPI_COPY_TYPE_PACKAGE,
					  this_source_obj, state, context);
			if (ACPI_FAILURE(status)) {
				return_ACPI_STATUS(status);
Linus Torvalds's avatar
Linus Torvalds committed
745 746 747 748 749 750
			}

			/*
			 * Push the current state and create a new one
			 * The callback above returned a new target package object.
			 */
Len Brown's avatar
Len Brown committed
751 752 753 754
			acpi_ut_push_generic_state(&state_list, state);
			state = acpi_ut_create_pkg_state(this_source_obj,
							 state->pkg.
							 this_target_obj, 0);
Linus Torvalds's avatar
Linus Torvalds committed
755
			if (!state) {
Len Brown's avatar
Len Brown committed
756
				return_ACPI_STATUS(AE_NO_MEMORY);
Linus Torvalds's avatar
Linus Torvalds committed
757 758 759 760 761 762
			}
		}
	}

	/* We should never get here */

Len Brown's avatar
Len Brown committed
763
	return_ACPI_STATUS(AE_AML_INTERNAL);
Linus Torvalds's avatar
Linus Torvalds committed
764 765 766 767 768 769 770 771 772
}

/*******************************************************************************
 *
 * FUNCTION:    acpi_ut_generate_checksum
 *
 * PARAMETERS:  Buffer          - Buffer to be scanned
 *              Length          - number of bytes to examine
 *
773
 * RETURN:      The generated checksum
Linus Torvalds's avatar
Linus Torvalds committed
774 775 776 777 778
 *
 * DESCRIPTION: Generate a checksum on a raw buffer
 *
 ******************************************************************************/

Len Brown's avatar
Len Brown committed
779
u8 acpi_ut_generate_checksum(u8 * buffer, u32 length)
Linus Torvalds's avatar
Linus Torvalds committed
780
{
Len Brown's avatar
Len Brown committed
781 782
	u32 i;
	signed char sum = 0;
Linus Torvalds's avatar
Linus Torvalds committed
783 784

	for (i = 0; i < length; i++) {
Len Brown's avatar
Len Brown committed
785
		sum = (signed char)(sum + buffer[i]);
Linus Torvalds's avatar
Linus Torvalds committed
786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802
	}

	return ((u8) (0 - sum));
}

/*******************************************************************************
 *
 * FUNCTION:    acpi_ut_get_resource_end_tag
 *
 * PARAMETERS:  obj_desc        - The resource template buffer object
 *
 * RETURN:      Pointer to the end tag
 *
 * DESCRIPTION: Find the END_TAG resource descriptor in a resource template
 *
 ******************************************************************************/

Len Brown's avatar
Len Brown committed
803
u8 *acpi_ut_get_resource_end_tag(union acpi_operand_object * obj_desc)
Linus Torvalds's avatar
Linus Torvalds committed
804
{
Len Brown's avatar
Len Brown committed
805 806 807
	u8 buffer_byte;
	u8 *buffer;
	u8 *end_buffer;
Linus Torvalds's avatar
Linus Torvalds committed
808

Len Brown's avatar
Len Brown committed
809
	buffer = obj_desc->buffer.pointer;
Linus Torvalds's avatar
Linus Torvalds committed
810 811 812 813
	end_buffer = buffer + obj_desc->buffer.length;

	while (buffer < end_buffer) {
		buffer_byte = *buffer;
Robert Moore's avatar
Robert Moore committed
814
		if (buffer_byte & ACPI_RDESC_TYPE_LARGE) {
Linus Torvalds's avatar
Linus Torvalds committed
815 816
			/* Large Descriptor - Length is next 2 bytes */

Len Brown's avatar
Len Brown committed
817 818
			buffer += ((*(buffer + 1) | (*(buffer + 2) << 8)) + 3);
		} else {
Linus Torvalds's avatar
Linus Torvalds committed
819 820
			/* Small Descriptor.  End Tag will be found here */

Len Brown's avatar
Len Brown committed
821 822
			if ((buffer_byte & ACPI_RDESC_SMALL_MASK) ==
			    ACPI_RDESC_TYPE_END_TAG) {
Linus Torvalds's avatar
Linus Torvalds committed
823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852
				/* Found the end tag descriptor, all done. */

				return (buffer);
			}

			/* Length is in the header */

			buffer += ((buffer_byte & 0x07) + 1);
		}
	}

	/* End tag not found */

	return (NULL);
}

/*******************************************************************************
 *
 * FUNCTION:    acpi_ut_report_error
 *
 * PARAMETERS:  module_name         - Caller's module name (for error output)
 *              line_number         - Caller's line number (for error output)
 *              component_id        - Caller's component ID (for error output)
 *
 * RETURN:      None
 *
 * DESCRIPTION: Print error message
 *
 ******************************************************************************/

Len Brown's avatar
Len Brown committed
853
void acpi_ut_report_error(char *module_name, u32 line_number, u32 component_id)
Linus Torvalds's avatar
Linus Torvalds committed
854 855
{

Len Brown's avatar
Len Brown committed
856
	acpi_os_printf("%8s-%04d: *** Error: ", module_name, line_number);
Linus Torvalds's avatar
Linus Torvalds committed
857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873
}

/*******************************************************************************
 *
 * FUNCTION:    acpi_ut_report_warning
 *
 * PARAMETERS:  module_name         - Caller's module name (for error output)
 *              line_number         - Caller's line number (for error output)
 *              component_id        - Caller's component ID (for error output)
 *
 * RETURN:      None
 *
 * DESCRIPTION: Print warning message
 *
 ******************************************************************************/

void
Len Brown's avatar
Len Brown committed
874
acpi_ut_report_warning(char *module_name, u32 line_number, u32 component_id)
Linus Torvalds's avatar
Linus Torvalds committed
875 876
{

Len Brown's avatar
Len Brown committed
877
	acpi_os_printf("%8s-%04d: *** Warning: ", module_name, line_number);
Linus Torvalds's avatar
Linus Torvalds committed
878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893
}

/*******************************************************************************
 *
 * FUNCTION:    acpi_ut_report_info
 *
 * PARAMETERS:  module_name         - Caller's module name (for error output)
 *              line_number         - Caller's line number (for error output)
 *              component_id        - Caller's component ID (for error output)
 *
 * RETURN:      None
 *
 * DESCRIPTION: Print information message
 *
 ******************************************************************************/

Len Brown's avatar
Len Brown committed
894
void acpi_ut_report_info(char *module_name, u32 line_number, u32 component_id)
Linus Torvalds's avatar
Linus Torvalds committed
895 896
{

Len Brown's avatar
Len Brown committed
897
	acpi_os_printf("%8s-%04d: *** Info: ", module_name, line_number);
Linus Torvalds's avatar
Linus Torvalds committed
898
}