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