exutils.c 12.6 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3 4 5 6 7 8

/******************************************************************************
 *
 * Module Name: exutils - interpreter/scanner utilities
 *
 *****************************************************************************/

/*
L
Len Brown 已提交
9
 * Copyright (C) 2000 - 2008, Intel Corp.
L
Linus Torvalds 已提交
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 48 49 50 51 52 53 54 55 56 57 58 59 60 61
 * 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.
 */

/*
 * DEFINE_AML_GLOBALS is tested in amlcode.h
 * to determine whether certain global names should be "defined" or only
 * "declared" in the current compilation.  This enhances maintainability
 * by enabling a single header file to embody all knowledge of the names
 * in question.
 *
 * Exactly one module of any executable should #define DEFINE_GLOBALS
 * before #including the header files which use this convention.  The
 * names in question will be defined and initialized in that module,
 * and declared as extern in all other modules which #include those
 * header files.
 */

#define DEFINE_AML_GLOBALS

#include <acpi/acpi.h>
L
Len Brown 已提交
62 63 64
#include "accommon.h"
#include "acinterp.h"
#include "amlcode.h"
L
Linus Torvalds 已提交
65 66

#define _COMPONENT          ACPI_EXECUTER
L
Len Brown 已提交
67
ACPI_MODULE_NAME("exutils")
L
Linus Torvalds 已提交
68

R
Robert Moore 已提交
69
/* Local prototypes */
L
Len Brown 已提交
70
static u32 acpi_ex_digits_needed(acpi_integer value, u32 base);
R
Robert Moore 已提交
71 72

#ifndef ACPI_NO_METHOD_EXECUTION
L
Linus Torvalds 已提交
73 74 75 76 77 78
/*******************************************************************************
 *
 * FUNCTION:    acpi_ex_enter_interpreter
 *
 * PARAMETERS:  None
 *
79
 * RETURN:      None
R
Robert Moore 已提交
80
 *
81 82 83
 * DESCRIPTION: Enter the interpreter execution region. Failure to enter
 *              the interpreter region is a fatal system error. Used in
 *              conjunction with exit_interpreter.
L
Linus Torvalds 已提交
84 85 86
 *
 ******************************************************************************/

87
void acpi_ex_enter_interpreter(void)
L
Linus Torvalds 已提交
88
{
L
Len Brown 已提交
89
	acpi_status status;
L
Linus Torvalds 已提交
90

91
	ACPI_FUNCTION_TRACE(ex_enter_interpreter);
L
Linus Torvalds 已提交
92

B
Bob Moore 已提交
93
	status = acpi_ut_acquire_mutex(ACPI_MTX_INTERPRETER);
L
Len Brown 已提交
94
	if (ACPI_FAILURE(status)) {
95 96
		ACPI_ERROR((AE_INFO,
			    "Could not acquire AML Interpreter mutex"));
L
Linus Torvalds 已提交
97 98
	}

99
	return_VOID;
100 101 102 103
}

/*******************************************************************************
 *
104
 * FUNCTION:    acpi_ex_reacquire_interpreter
105 106 107 108
 *
 * PARAMETERS:  None
 *
 * RETURN:      None
L
Linus Torvalds 已提交
109
 *
110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139
 * DESCRIPTION: Reacquire the interpreter execution region from within the
 *              interpreter code. Failure to enter the interpreter region is a
 *              fatal system error. Used in  conjuction with
 *              relinquish_interpreter
 *
 ******************************************************************************/

void acpi_ex_reacquire_interpreter(void)
{
	ACPI_FUNCTION_TRACE(ex_reacquire_interpreter);

	/*
	 * If the global serialized flag is set, do not release the interpreter,
	 * since it was not actually released by acpi_ex_relinquish_interpreter.
	 * This forces the interpreter to be single threaded.
	 */
	if (!acpi_gbl_all_methods_serialized) {
		acpi_ex_enter_interpreter();
	}

	return_VOID;
}

/*******************************************************************************
 *
 * FUNCTION:    acpi_ex_exit_interpreter
 *
 * PARAMETERS:  None
 *
 * RETURN:      None
140
 *
141 142 143
 * DESCRIPTION: Exit the interpreter execution region. This is the top level
 *              routine used to exit the interpreter when all processing has
 *              been completed.
L
Linus Torvalds 已提交
144 145 146
 *
 ******************************************************************************/

L
Len Brown 已提交
147
void acpi_ex_exit_interpreter(void)
L
Linus Torvalds 已提交
148
{
L
Len Brown 已提交
149
	acpi_status status;
L
Linus Torvalds 已提交
150

B
Bob Moore 已提交
151
	ACPI_FUNCTION_TRACE(ex_exit_interpreter);
L
Linus Torvalds 已提交
152

B
Bob Moore 已提交
153
	status = acpi_ut_release_mutex(ACPI_MTX_INTERPRETER);
L
Len Brown 已提交
154
	if (ACPI_FAILURE(status)) {
155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194
		ACPI_ERROR((AE_INFO,
			    "Could not release AML Interpreter mutex"));
	}

	return_VOID;
}

/*******************************************************************************
 *
 * FUNCTION:    acpi_ex_relinquish_interpreter
 *
 * PARAMETERS:  None
 *
 * RETURN:      None
 *
 * DESCRIPTION: Exit the interpreter execution region, from within the
 *              interpreter - before attempting an operation that will possibly
 *              block the running thread.
 *
 * Cases where the interpreter is unlocked internally
 *      1) Method to be blocked on a Sleep() AML opcode
 *      2) Method to be blocked on an Acquire() AML opcode
 *      3) Method to be blocked on a Wait() AML opcode
 *      4) Method to be blocked to acquire the global lock
 *      5) Method to be blocked waiting to execute a serialized control method
 *          that is currently executing
 *      6) About to invoke a user-installed opregion handler
 *
 ******************************************************************************/

void acpi_ex_relinquish_interpreter(void)
{
	ACPI_FUNCTION_TRACE(ex_relinquish_interpreter);

	/*
	 * If the global serialized flag is set, do not release the interpreter.
	 * This forces the interpreter to be single threaded.
	 */
	if (!acpi_gbl_all_methods_serialized) {
		acpi_ex_exit_interpreter();
L
Linus Torvalds 已提交
195 196 197 198 199 200 201 202 203 204 205 206 207
	}

	return_VOID;
}

/*******************************************************************************
 *
 * FUNCTION:    acpi_ex_truncate_for32bit_table
 *
 * PARAMETERS:  obj_desc        - Object to be truncated
 *
 * RETURN:      none
 *
208 209
 * DESCRIPTION: Truncate an ACPI Integer to 32 bits if the execution mode is
 *              32-bit, as determined by the revision of the DSDT.
L
Linus Torvalds 已提交
210 211 212
 *
 ******************************************************************************/

L
Len Brown 已提交
213
void acpi_ex_truncate_for32bit_table(union acpi_operand_object *obj_desc)
L
Linus Torvalds 已提交
214 215
{

L
Len Brown 已提交
216
	ACPI_FUNCTION_ENTRY();
L
Linus Torvalds 已提交
217 218 219

	/*
	 * Object must be a valid number and we must be executing
220
	 * a control method. NS node could be there for AML_INT_NAMEPATH_OP.
L
Linus Torvalds 已提交
221 222
	 */
	if ((!obj_desc) ||
223
	    (ACPI_GET_DESCRIPTOR_TYPE(obj_desc) != ACPI_DESC_TYPE_OPERAND) ||
224
	    (obj_desc->common.type != ACPI_TYPE_INTEGER)) {
L
Linus Torvalds 已提交
225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243
		return;
	}

	if (acpi_gbl_integer_byte_width == 4) {
		/*
		 * We are running a method that exists in a 32-bit ACPI table.
		 * Truncate the value to 32 bits by zeroing out the upper 32-bit field
		 */
		obj_desc->integer.value &= (acpi_integer) ACPI_UINT32_MAX;
	}
}

/*******************************************************************************
 *
 * FUNCTION:    acpi_ex_acquire_global_lock
 *
 * PARAMETERS:  field_flags           - Flags with Lock rule:
 *                                      always_lock or never_lock
 *
244
 * RETURN:      None
L
Linus Torvalds 已提交
245
 *
246 247
 * DESCRIPTION: Obtain the ACPI hardware Global Lock, only if the field
 *              flags specifiy that it is to be obtained before field access.
L
Linus Torvalds 已提交
248 249 250
 *
 ******************************************************************************/

251
void acpi_ex_acquire_global_lock(u32 field_flags)
L
Linus Torvalds 已提交
252
{
L
Len Brown 已提交
253
	acpi_status status;
L
Linus Torvalds 已提交
254

B
Bob Moore 已提交
255
	ACPI_FUNCTION_TRACE(ex_acquire_global_lock);
L
Linus Torvalds 已提交
256

257 258 259 260 261
	/* Only use the lock if the always_lock bit is set */

	if (!(field_flags & AML_FIELD_LOCK_RULE_MASK)) {
		return_VOID;
	}
L
Linus Torvalds 已提交
262

263
	/* Attempt to get the global lock, wait forever */
B
Bob Moore 已提交
264

265 266 267
	status = acpi_ex_acquire_mutex_object(ACPI_WAIT_FOREVER,
					      acpi_gbl_global_lock_mutex,
					      acpi_os_get_thread_id());
L
Linus Torvalds 已提交
268

269 270 271
	if (ACPI_FAILURE(status)) {
		ACPI_EXCEPTION((AE_INFO, status,
				"Could not acquire Global Lock"));
L
Linus Torvalds 已提交
272 273
	}

274
	return_VOID;
L
Linus Torvalds 已提交
275 276 277 278 279 280
}

/*******************************************************************************
 *
 * FUNCTION:    acpi_ex_release_global_lock
 *
281 282
 * PARAMETERS:  field_flags           - Flags with Lock rule:
 *                                      always_lock or never_lock
L
Linus Torvalds 已提交
283
 *
R
Robert Moore 已提交
284
 * RETURN:      None
L
Linus Torvalds 已提交
285
 *
286
 * DESCRIPTION: Release the ACPI hardware Global Lock
L
Linus Torvalds 已提交
287 288 289
 *
 ******************************************************************************/

290
void acpi_ex_release_global_lock(u32 field_flags)
L
Linus Torvalds 已提交
291
{
L
Len Brown 已提交
292
	acpi_status status;
L
Linus Torvalds 已提交
293

B
Bob Moore 已提交
294
	ACPI_FUNCTION_TRACE(ex_release_global_lock);
L
Linus Torvalds 已提交
295

296 297 298 299 300 301
	/* Only use the lock if the always_lock bit is set */

	if (!(field_flags & AML_FIELD_LOCK_RULE_MASK)) {
		return_VOID;
	}

302
	/* Release the global lock */
B
Bob Moore 已提交
303

304 305
	status = acpi_ex_release_mutex_object(acpi_gbl_global_lock_mutex);
	if (ACPI_FAILURE(status)) {
B
Bob Moore 已提交
306

307
		/* Report the error, but there isn't much else we can do */
L
Linus Torvalds 已提交
308

309 310
		ACPI_EXCEPTION((AE_INFO, status,
				"Could not release Global Lock"));
L
Linus Torvalds 已提交
311 312 313 314 315 316 317 318 319 320 321 322
	}

	return_VOID;
}

/*******************************************************************************
 *
 * FUNCTION:    acpi_ex_digits_needed
 *
 * PARAMETERS:  Value           - Value to be represented
 *              Base            - Base of representation
 *
R
Robert Moore 已提交
323 324 325 326
 * RETURN:      The number of digits.
 *
 * DESCRIPTION: Calculate the number of digits needed to represent the Value
 *              in the given Base (Radix)
L
Linus Torvalds 已提交
327 328 329
 *
 ******************************************************************************/

L
Len Brown 已提交
330
static u32 acpi_ex_digits_needed(acpi_integer value, u32 base)
L
Linus Torvalds 已提交
331
{
L
Len Brown 已提交
332 333
	u32 num_digits;
	acpi_integer current_value;
L
Linus Torvalds 已提交
334

B
Bob Moore 已提交
335
	ACPI_FUNCTION_TRACE(ex_digits_needed);
L
Linus Torvalds 已提交
336 337 338 339

	/* acpi_integer is unsigned, so we don't worry about a '-' prefix */

	if (value == 0) {
B
Bob Moore 已提交
340
		return_UINT32(1);
L
Linus Torvalds 已提交
341 342 343 344 345 346 347 348
	}

	current_value = value;
	num_digits = 0;

	/* Count the digits in the requested base */

	while (current_value) {
L
Len Brown 已提交
349 350
		(void)acpi_ut_short_divide(current_value, base, &current_value,
					   NULL);
L
Linus Torvalds 已提交
351 352 353
		num_digits++;
	}

B
Bob Moore 已提交
354
	return_UINT32(num_digits);
L
Linus Torvalds 已提交
355 356 357 358 359 360 361 362 363
}

/*******************************************************************************
 *
 * FUNCTION:    acpi_ex_eisa_id_to_string
 *
 * PARAMETERS:  numeric_id      - EISA ID to be converted
 *              out_string      - Where to put the converted string (8 bytes)
 *
R
Robert Moore 已提交
364 365
 * RETURN:      None
 *
L
Linus Torvalds 已提交
366 367 368 369
 * DESCRIPTION: Convert a numeric EISA ID to string representation
 *
 ******************************************************************************/

L
Len Brown 已提交
370
void acpi_ex_eisa_id_to_string(u32 numeric_id, char *out_string)
L
Linus Torvalds 已提交
371
{
L
Len Brown 已提交
372
	u32 eisa_id;
L
Linus Torvalds 已提交
373

L
Len Brown 已提交
374
	ACPI_FUNCTION_ENTRY();
L
Linus Torvalds 已提交
375 376 377

	/* Swap ID to big-endian to get contiguous bits */

L
Len Brown 已提交
378
	eisa_id = acpi_ut_dword_byte_swap(numeric_id);
L
Linus Torvalds 已提交
379

L
Len Brown 已提交
380 381 382 383 384 385 386
	out_string[0] = (char)('@' + (((unsigned long)eisa_id >> 26) & 0x1f));
	out_string[1] = (char)('@' + ((eisa_id >> 21) & 0x1f));
	out_string[2] = (char)('@' + ((eisa_id >> 16) & 0x1f));
	out_string[3] = acpi_ut_hex_to_ascii_char((acpi_integer) eisa_id, 12);
	out_string[4] = acpi_ut_hex_to_ascii_char((acpi_integer) eisa_id, 8);
	out_string[5] = acpi_ut_hex_to_ascii_char((acpi_integer) eisa_id, 4);
	out_string[6] = acpi_ut_hex_to_ascii_char((acpi_integer) eisa_id, 0);
L
Linus Torvalds 已提交
387 388 389 390 391 392 393 394 395 396
	out_string[7] = 0;
}

/*******************************************************************************
 *
 * FUNCTION:    acpi_ex_unsigned_integer_to_string
 *
 * PARAMETERS:  Value           - Value to be converted
 *              out_string      - Where to put the converted string (8 bytes)
 *
R
Robert Moore 已提交
397 398
 * RETURN:      None, string
 *
399
 * DESCRIPTION: Convert a number to string representation. Assumes string
R
Robert Moore 已提交
400
 *              buffer is large enough to hold the string.
L
Linus Torvalds 已提交
401 402 403
 *
 ******************************************************************************/

L
Len Brown 已提交
404
void acpi_ex_unsigned_integer_to_string(acpi_integer value, char *out_string)
L
Linus Torvalds 已提交
405
{
L
Len Brown 已提交
406 407 408
	u32 count;
	u32 digits_needed;
	u32 remainder;
L
Linus Torvalds 已提交
409

L
Len Brown 已提交
410
	ACPI_FUNCTION_ENTRY();
L
Linus Torvalds 已提交
411

L
Len Brown 已提交
412
	digits_needed = acpi_ex_digits_needed(value, 10);
L
Linus Torvalds 已提交
413 414 415
	out_string[digits_needed] = 0;

	for (count = digits_needed; count > 0; count--) {
L
Len Brown 已提交
416 417
		(void)acpi_ut_short_divide(value, 10, &value, &remainder);
		out_string[count - 1] = (char)('0' + remainder);
L
Linus Torvalds 已提交
418 419 420 421
	}
}

#endif