Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /****************************************************************************** |
2 | * | |
3 | * Module Name: exutils - interpreter/scanner utilities | |
4 | * | |
5 | *****************************************************************************/ | |
6 | ||
7 | /* | |
c8100dc4 | 8 | * Copyright (C) 2000 - 2016, Intel Corp. |
1da177e4 LT |
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 | ||
1da177e4 LT |
44 | /* |
45 | * DEFINE_AML_GLOBALS is tested in amlcode.h | |
46 | * to determine whether certain global names should be "defined" or only | |
73a3090a | 47 | * "declared" in the current compilation. This enhances maintainability |
1da177e4 LT |
48 | * by enabling a single header file to embody all knowledge of the names |
49 | * in question. | |
50 | * | |
51 | * Exactly one module of any executable should #define DEFINE_GLOBALS | |
73a3090a | 52 | * before #including the header files which use this convention. The |
1da177e4 LT |
53 | * names in question will be defined and initialized in that module, |
54 | * and declared as extern in all other modules which #include those | |
55 | * header files. | |
56 | */ | |
57 | ||
58 | #define DEFINE_AML_GLOBALS | |
59 | ||
60 | #include <acpi/acpi.h> | |
e2f7a777 LB |
61 | #include "accommon.h" |
62 | #include "acinterp.h" | |
63 | #include "amlcode.h" | |
1da177e4 LT |
64 | |
65 | #define _COMPONENT ACPI_EXECUTER | |
4be44fcd | 66 | ACPI_MODULE_NAME("exutils") |
1da177e4 | 67 | |
44f6c012 | 68 | /* Local prototypes */ |
5df7e6cb | 69 | static u32 acpi_ex_digits_needed(u64 value, u32 base); |
44f6c012 RM |
70 | |
71 | #ifndef ACPI_NO_METHOD_EXECUTION | |
1da177e4 LT |
72 | /******************************************************************************* |
73 | * | |
74 | * FUNCTION: acpi_ex_enter_interpreter | |
75 | * | |
76 | * PARAMETERS: None | |
77 | * | |
4d2acd9e | 78 | * RETURN: None |
44f6c012 | 79 | * |
4d2acd9e LB |
80 | * DESCRIPTION: Enter the interpreter execution region. Failure to enter |
81 | * the interpreter region is a fatal system error. Used in | |
82 | * conjunction with exit_interpreter. | |
1da177e4 LT |
83 | * |
84 | ******************************************************************************/ | |
85 | ||
4d2acd9e | 86 | void acpi_ex_enter_interpreter(void) |
1da177e4 | 87 | { |
4be44fcd | 88 | acpi_status status; |
1da177e4 | 89 | |
977a6226 | 90 | ACPI_FUNCTION_TRACE(ex_enter_interpreter); |
1da177e4 | 91 | |
4c90ece2 | 92 | status = acpi_ut_acquire_mutex(ACPI_MTX_INTERPRETER); |
4be44fcd | 93 | if (ACPI_FAILURE(status)) { |
4d2acd9e LB |
94 | ACPI_ERROR((AE_INFO, |
95 | "Could not acquire AML Interpreter mutex")); | |
1da177e4 LT |
96 | } |
97 | ||
4d2acd9e | 98 | return_VOID; |
1ba753ac BM |
99 | } |
100 | ||
4d2acd9e LB |
101 | /******************************************************************************* |
102 | * | |
103 | * FUNCTION: acpi_ex_exit_interpreter | |
104 | * | |
105 | * PARAMETERS: None | |
106 | * | |
107 | * RETURN: None | |
a8f4af6d | 108 | * |
4d2acd9e LB |
109 | * DESCRIPTION: Exit the interpreter execution region. This is the top level |
110 | * routine used to exit the interpreter when all processing has | |
e2b8ddcc LZ |
111 | * been completed, or when the method blocks. |
112 | * | |
113 | * Cases where the interpreter is unlocked internally: | |
114 | * 1) Method will be blocked on a Sleep() AML opcode | |
115 | * 2) Method will be blocked on an Acquire() AML opcode | |
116 | * 3) Method will be blocked on a Wait() AML opcode | |
117 | * 4) Method will be blocked to acquire the global lock | |
118 | * 5) Method will be blocked waiting to execute a serialized control | |
119 | * method that is currently executing | |
120 | * 6) About to invoke a user-installed opregion handler | |
1da177e4 LT |
121 | * |
122 | ******************************************************************************/ | |
123 | ||
4be44fcd | 124 | void acpi_ex_exit_interpreter(void) |
1da177e4 | 125 | { |
4be44fcd | 126 | acpi_status status; |
1da177e4 | 127 | |
b229cf92 | 128 | ACPI_FUNCTION_TRACE(ex_exit_interpreter); |
1da177e4 | 129 | |
4c90ece2 | 130 | status = acpi_ut_release_mutex(ACPI_MTX_INTERPRETER); |
4be44fcd | 131 | if (ACPI_FAILURE(status)) { |
4d2acd9e LB |
132 | ACPI_ERROR((AE_INFO, |
133 | "Could not release AML Interpreter mutex")); | |
134 | } | |
135 | ||
136 | return_VOID; | |
137 | } | |
138 | ||
1da177e4 LT |
139 | /******************************************************************************* |
140 | * | |
141 | * FUNCTION: acpi_ex_truncate_for32bit_table | |
142 | * | |
143 | * PARAMETERS: obj_desc - Object to be truncated | |
144 | * | |
ef42e53f | 145 | * RETURN: TRUE if a truncation was performed, FALSE otherwise. |
1da177e4 | 146 | * |
4d2acd9e LB |
147 | * DESCRIPTION: Truncate an ACPI Integer to 32 bits if the execution mode is |
148 | * 32-bit, as determined by the revision of the DSDT. | |
1da177e4 LT |
149 | * |
150 | ******************************************************************************/ | |
151 | ||
ef42e53f | 152 | u8 acpi_ex_truncate_for32bit_table(union acpi_operand_object *obj_desc) |
1da177e4 LT |
153 | { |
154 | ||
4be44fcd | 155 | ACPI_FUNCTION_ENTRY(); |
1da177e4 LT |
156 | |
157 | /* | |
158 | * Object must be a valid number and we must be executing | |
ef42e53f | 159 | * a control method. Object could be NS node for AML_INT_NAMEPATH_OP. |
1da177e4 LT |
160 | */ |
161 | if ((!obj_desc) || | |
4e3156b1 | 162 | (ACPI_GET_DESCRIPTOR_TYPE(obj_desc) != ACPI_DESC_TYPE_OPERAND) || |
3371c19c | 163 | (obj_desc->common.type != ACPI_TYPE_INTEGER)) { |
ef42e53f | 164 | return (FALSE); |
1da177e4 LT |
165 | } |
166 | ||
ef42e53f BM |
167 | if ((acpi_gbl_integer_byte_width == 4) && |
168 | (obj_desc->integer.value > (u64)ACPI_UINT32_MAX)) { | |
1da177e4 | 169 | /* |
1fad8738 BM |
170 | * We are executing in a 32-bit ACPI table. Truncate |
171 | * the value to 32 bits by zeroing out the upper 32-bit field | |
1da177e4 | 172 | */ |
ef42e53f BM |
173 | obj_desc->integer.value &= (u64)ACPI_UINT32_MAX; |
174 | return (TRUE); | |
1da177e4 | 175 | } |
ef42e53f BM |
176 | |
177 | return (FALSE); | |
1da177e4 LT |
178 | } |
179 | ||
1da177e4 LT |
180 | /******************************************************************************* |
181 | * | |
182 | * FUNCTION: acpi_ex_acquire_global_lock | |
183 | * | |
184 | * PARAMETERS: field_flags - Flags with Lock rule: | |
185 | * always_lock or never_lock | |
186 | * | |
ba886cd4 | 187 | * RETURN: None |
1da177e4 | 188 | * |
ba886cd4 BM |
189 | * DESCRIPTION: Obtain the ACPI hardware Global Lock, only if the field |
190 | * flags specifiy that it is to be obtained before field access. | |
1da177e4 LT |
191 | * |
192 | ******************************************************************************/ | |
193 | ||
ba886cd4 | 194 | void acpi_ex_acquire_global_lock(u32 field_flags) |
1da177e4 | 195 | { |
4be44fcd | 196 | acpi_status status; |
1da177e4 | 197 | |
b229cf92 | 198 | ACPI_FUNCTION_TRACE(ex_acquire_global_lock); |
1da177e4 | 199 | |
ba886cd4 BM |
200 | /* Only use the lock if the always_lock bit is set */ |
201 | ||
202 | if (!(field_flags & AML_FIELD_LOCK_RULE_MASK)) { | |
203 | return_VOID; | |
204 | } | |
1da177e4 | 205 | |
ba886cd4 | 206 | /* Attempt to get the global lock, wait forever */ |
52fc0b02 | 207 | |
ba886cd4 BM |
208 | status = acpi_ex_acquire_mutex_object(ACPI_WAIT_FOREVER, |
209 | acpi_gbl_global_lock_mutex, | |
210 | acpi_os_get_thread_id()); | |
1da177e4 | 211 | |
ba886cd4 BM |
212 | if (ACPI_FAILURE(status)) { |
213 | ACPI_EXCEPTION((AE_INFO, status, | |
214 | "Could not acquire Global Lock")); | |
1da177e4 LT |
215 | } |
216 | ||
ba886cd4 | 217 | return_VOID; |
1da177e4 LT |
218 | } |
219 | ||
1da177e4 LT |
220 | /******************************************************************************* |
221 | * | |
222 | * FUNCTION: acpi_ex_release_global_lock | |
223 | * | |
f02e9fa1 BM |
224 | * PARAMETERS: field_flags - Flags with Lock rule: |
225 | * always_lock or never_lock | |
1da177e4 | 226 | * |
44f6c012 | 227 | * RETURN: None |
1da177e4 | 228 | * |
ba886cd4 | 229 | * DESCRIPTION: Release the ACPI hardware Global Lock |
1da177e4 LT |
230 | * |
231 | ******************************************************************************/ | |
232 | ||
f02e9fa1 | 233 | void acpi_ex_release_global_lock(u32 field_flags) |
1da177e4 | 234 | { |
4be44fcd | 235 | acpi_status status; |
1da177e4 | 236 | |
b229cf92 | 237 | ACPI_FUNCTION_TRACE(ex_release_global_lock); |
1da177e4 | 238 | |
f02e9fa1 BM |
239 | /* Only use the lock if the always_lock bit is set */ |
240 | ||
241 | if (!(field_flags & AML_FIELD_LOCK_RULE_MASK)) { | |
242 | return_VOID; | |
243 | } | |
244 | ||
ba886cd4 | 245 | /* Release the global lock */ |
52fc0b02 | 246 | |
ba886cd4 BM |
247 | status = acpi_ex_release_mutex_object(acpi_gbl_global_lock_mutex); |
248 | if (ACPI_FAILURE(status)) { | |
52fc0b02 | 249 | |
ba886cd4 | 250 | /* Report the error, but there isn't much else we can do */ |
1da177e4 | 251 | |
ba886cd4 BM |
252 | ACPI_EXCEPTION((AE_INFO, status, |
253 | "Could not release Global Lock")); | |
1da177e4 LT |
254 | } |
255 | ||
256 | return_VOID; | |
257 | } | |
258 | ||
1da177e4 LT |
259 | /******************************************************************************* |
260 | * | |
261 | * FUNCTION: acpi_ex_digits_needed | |
262 | * | |
ba494bee BM |
263 | * PARAMETERS: value - Value to be represented |
264 | * base - Base of representation | |
1da177e4 | 265 | * |
44f6c012 RM |
266 | * RETURN: The number of digits. |
267 | * | |
268 | * DESCRIPTION: Calculate the number of digits needed to represent the Value | |
269 | * in the given Base (Radix) | |
1da177e4 LT |
270 | * |
271 | ******************************************************************************/ | |
272 | ||
5df7e6cb | 273 | static u32 acpi_ex_digits_needed(u64 value, u32 base) |
1da177e4 | 274 | { |
4be44fcd | 275 | u32 num_digits; |
5df7e6cb | 276 | u64 current_value; |
1da177e4 | 277 | |
b229cf92 | 278 | ACPI_FUNCTION_TRACE(ex_digits_needed); |
1da177e4 | 279 | |
5df7e6cb | 280 | /* u64 is unsigned, so we don't worry about a '-' prefix */ |
1da177e4 LT |
281 | |
282 | if (value == 0) { | |
fd1af712 | 283 | return_UINT32(1); |
1da177e4 LT |
284 | } |
285 | ||
286 | current_value = value; | |
287 | num_digits = 0; | |
288 | ||
289 | /* Count the digits in the requested base */ | |
290 | ||
291 | while (current_value) { | |
4be44fcd LB |
292 | (void)acpi_ut_short_divide(current_value, base, ¤t_value, |
293 | NULL); | |
1da177e4 LT |
294 | num_digits++; |
295 | } | |
296 | ||
fd1af712 | 297 | return_UINT32(num_digits); |
1da177e4 LT |
298 | } |
299 | ||
1da177e4 LT |
300 | /******************************************************************************* |
301 | * | |
302 | * FUNCTION: acpi_ex_eisa_id_to_string | |
303 | * | |
d8aa069a BM |
304 | * PARAMETERS: out_string - Where to put the converted string (8 bytes) |
305 | * compressed_id - EISAID to be converted | |
1da177e4 | 306 | * |
44f6c012 RM |
307 | * RETURN: None |
308 | * | |
15b8dd53 BM |
309 | * DESCRIPTION: Convert a numeric EISAID to string representation. Return |
310 | * buffer must be large enough to hold the string. The string | |
311 | * returned is always exactly of length ACPI_EISAID_STRING_SIZE | |
312 | * (includes null terminator). The EISAID is always 32 bits. | |
1da177e4 LT |
313 | * |
314 | ******************************************************************************/ | |
315 | ||
5df7e6cb | 316 | void acpi_ex_eisa_id_to_string(char *out_string, u64 compressed_id) |
1da177e4 | 317 | { |
15b8dd53 | 318 | u32 swapped_id; |
1da177e4 | 319 | |
4be44fcd | 320 | ACPI_FUNCTION_ENTRY(); |
1da177e4 | 321 | |
15b8dd53 BM |
322 | /* The EISAID should be a 32-bit integer */ |
323 | ||
324 | if (compressed_id > ACPI_UINT32_MAX) { | |
325 | ACPI_WARNING((AE_INFO, | |
1fad8738 BM |
326 | "Expected EISAID is larger than 32 bits: " |
327 | "0x%8.8X%8.8X, truncating", | |
15b8dd53 BM |
328 | ACPI_FORMAT_UINT64(compressed_id))); |
329 | } | |
330 | ||
1da177e4 LT |
331 | /* Swap ID to big-endian to get contiguous bits */ |
332 | ||
15b8dd53 | 333 | swapped_id = acpi_ut_dword_byte_swap((u32)compressed_id); |
1da177e4 | 334 | |
15b8dd53 BM |
335 | /* First 3 bytes are uppercase letters. Next 4 bytes are hexadecimal */ |
336 | ||
337 | out_string[0] = | |
338 | (char)(0x40 + (((unsigned long)swapped_id >> 26) & 0x1F)); | |
339 | out_string[1] = (char)(0x40 + ((swapped_id >> 21) & 0x1F)); | |
340 | out_string[2] = (char)(0x40 + ((swapped_id >> 16) & 0x1F)); | |
5df7e6cb BM |
341 | out_string[3] = acpi_ut_hex_to_ascii_char((u64) swapped_id, 12); |
342 | out_string[4] = acpi_ut_hex_to_ascii_char((u64) swapped_id, 8); | |
343 | out_string[5] = acpi_ut_hex_to_ascii_char((u64) swapped_id, 4); | |
344 | out_string[6] = acpi_ut_hex_to_ascii_char((u64) swapped_id, 0); | |
1da177e4 LT |
345 | out_string[7] = 0; |
346 | } | |
347 | ||
1da177e4 LT |
348 | /******************************************************************************* |
349 | * | |
15b8dd53 | 350 | * FUNCTION: acpi_ex_integer_to_string |
1da177e4 | 351 | * |
15b8dd53 BM |
352 | * PARAMETERS: out_string - Where to put the converted string. At least |
353 | * 21 bytes are needed to hold the largest | |
354 | * possible 64-bit integer. | |
ba494bee | 355 | * value - Value to be converted |
1da177e4 | 356 | * |
d8aa069a | 357 | * RETURN: Converted string in out_string |
44f6c012 | 358 | * |
15b8dd53 BM |
359 | * DESCRIPTION: Convert a 64-bit integer to decimal string representation. |
360 | * Assumes string buffer is large enough to hold the string. The | |
361 | * largest string is (ACPI_MAX64_DECIMAL_DIGITS + 1). | |
1da177e4 LT |
362 | * |
363 | ******************************************************************************/ | |
364 | ||
5df7e6cb | 365 | void acpi_ex_integer_to_string(char *out_string, u64 value) |
1da177e4 | 366 | { |
4be44fcd LB |
367 | u32 count; |
368 | u32 digits_needed; | |
369 | u32 remainder; | |
1da177e4 | 370 | |
4be44fcd | 371 | ACPI_FUNCTION_ENTRY(); |
1da177e4 | 372 | |
4be44fcd | 373 | digits_needed = acpi_ex_digits_needed(value, 10); |
1da177e4 LT |
374 | out_string[digits_needed] = 0; |
375 | ||
376 | for (count = digits_needed; count > 0; count--) { | |
4be44fcd LB |
377 | (void)acpi_ut_short_divide(value, 10, &value, &remainder); |
378 | out_string[count - 1] = (char)('0' + remainder); | |
1da177e4 LT |
379 | } |
380 | } | |
381 | ||
f65358e5 SS |
382 | /******************************************************************************* |
383 | * | |
384 | * FUNCTION: acpi_ex_pci_cls_to_string | |
385 | * | |
386 | * PARAMETERS: out_string - Where to put the converted string (7 bytes) | |
d8aa069a | 387 | * class_code - PCI class code to be converted (3 bytes) |
f65358e5 | 388 | * |
d8aa069a | 389 | * RETURN: Converted string in out_string |
f65358e5 SS |
390 | * |
391 | * DESCRIPTION: Convert 3-bytes PCI class code to string representation. | |
392 | * Return buffer must be large enough to hold the string. The | |
393 | * string returned is always exactly of length | |
394 | * ACPI_PCICLS_STRING_SIZE (includes null terminator). | |
395 | * | |
396 | ******************************************************************************/ | |
397 | ||
398 | void acpi_ex_pci_cls_to_string(char *out_string, u8 class_code[3]) | |
399 | { | |
400 | ||
401 | ACPI_FUNCTION_ENTRY(); | |
402 | ||
403 | /* All 3 bytes are hexadecimal */ | |
404 | ||
405 | out_string[0] = acpi_ut_hex_to_ascii_char((u64)class_code[0], 4); | |
406 | out_string[1] = acpi_ut_hex_to_ascii_char((u64)class_code[0], 0); | |
407 | out_string[2] = acpi_ut_hex_to_ascii_char((u64)class_code[1], 4); | |
408 | out_string[3] = acpi_ut_hex_to_ascii_char((u64)class_code[1], 0); | |
409 | out_string[4] = acpi_ut_hex_to_ascii_char((u64)class_code[2], 4); | |
410 | out_string[5] = acpi_ut_hex_to_ascii_char((u64)class_code[2], 0); | |
411 | out_string[6] = 0; | |
412 | } | |
413 | ||
ec463666 BM |
414 | /******************************************************************************* |
415 | * | |
416 | * FUNCTION: acpi_is_valid_space_id | |
417 | * | |
418 | * PARAMETERS: space_id - ID to be validated | |
419 | * | |
d8aa069a | 420 | * RETURN: TRUE if space_id is a valid/supported ID. |
ec463666 | 421 | * |
ba494bee | 422 | * DESCRIPTION: Validate an operation region space_ID. |
ec463666 BM |
423 | * |
424 | ******************************************************************************/ | |
425 | ||
426 | u8 acpi_is_valid_space_id(u8 space_id) | |
427 | { | |
428 | ||
429 | if ((space_id >= ACPI_NUM_PREDEFINED_REGIONS) && | |
430 | (space_id < ACPI_USER_REGION_BEGIN) && | |
431 | (space_id != ACPI_ADR_SPACE_DATA_TABLE) && | |
432 | (space_id != ACPI_ADR_SPACE_FIXED_HARDWARE)) { | |
433 | return (FALSE); | |
434 | } | |
435 | ||
436 | return (TRUE); | |
437 | } | |
438 | ||
1da177e4 | 439 | #endif |