1 /*******************************************************************************
3 * Module Name: utmisc - common utility procedures
5 ******************************************************************************/
8 * Copyright (C) 2000 - 2015, Intel Corp.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
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.
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.
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.
44 #include <acpi/acpi.h>
48 #define _COMPONENT ACPI_UTILITIES
49 ACPI_MODULE_NAME("utmisc")
51 /*******************************************************************************
53 * FUNCTION: acpi_ut_is_pci_root_bridge
55 * PARAMETERS: id - The HID/CID in string format
57 * RETURN: TRUE if the Id is a match for a PCI/PCI-Express Root Bridge
59 * DESCRIPTION: Determine if the input ID is a PCI Root Bridge ID.
61 ******************************************************************************/
62 u8 acpi_ut_is_pci_root_bridge(char *id)
66 * Check if this is a PCI root bridge.
67 * ACPI 3.0+: check for a PCI Express root also.
70 PCI_ROOT_HID_STRING)) ||
71 !(ACPI_STRCMP(id, PCI_EXPRESS_ROOT_HID_STRING))) {
78 #if (defined ACPI_ASL_COMPILER || defined ACPI_EXEC_APP)
79 /*******************************************************************************
81 * FUNCTION: acpi_ut_is_aml_table
83 * PARAMETERS: table - An ACPI table
85 * RETURN: TRUE if table contains executable AML; FALSE otherwise
87 * DESCRIPTION: Check ACPI Signature for a table that contains AML code.
88 * Currently, these are DSDT,SSDT,PSDT. All other table types are
89 * data tables that do not contain AML code.
91 ******************************************************************************/
93 u8 acpi_ut_is_aml_table(struct acpi_table_header *table)
96 /* These are the only tables that contain executable AML */
98 if (ACPI_COMPARE_NAME(table->signature, ACPI_SIG_DSDT) ||
99 ACPI_COMPARE_NAME(table->signature, ACPI_SIG_PSDT) ||
100 ACPI_COMPARE_NAME(table->signature, ACPI_SIG_SSDT)) {
108 /*******************************************************************************
110 * FUNCTION: acpi_ut_dword_byte_swap
112 * PARAMETERS: value - Value to be converted
114 * RETURN: u32 integer with bytes swapped
116 * DESCRIPTION: Convert a 32-bit value to big-endian (swap the bytes)
118 ******************************************************************************/
120 u32 acpi_ut_dword_byte_swap(u32 value)
131 ACPI_FUNCTION_ENTRY();
135 out.bytes[0] = in.bytes[3];
136 out.bytes[1] = in.bytes[2];
137 out.bytes[2] = in.bytes[1];
138 out.bytes[3] = in.bytes[0];
143 /*******************************************************************************
145 * FUNCTION: acpi_ut_set_integer_width
147 * PARAMETERS: Revision From DSDT header
151 * DESCRIPTION: Set the global integer bit width based upon the revision
152 * of the DSDT. For Revision 1 and 0, Integers are 32 bits.
153 * For Revision 2 and above, Integers are 64 bits. Yes, this
154 * makes a difference.
156 ******************************************************************************/
158 void acpi_ut_set_integer_width(u8 revision)
165 acpi_gbl_integer_bit_width = 32;
166 acpi_gbl_integer_nybble_width = 8;
167 acpi_gbl_integer_byte_width = 4;
169 /* 64-bit case (ACPI 2.0+) */
171 acpi_gbl_integer_bit_width = 64;
172 acpi_gbl_integer_nybble_width = 16;
173 acpi_gbl_integer_byte_width = 8;
177 /*******************************************************************************
179 * FUNCTION: acpi_ut_create_update_state_and_push
181 * PARAMETERS: object - Object to be added to the new state
182 * action - Increment/Decrement
183 * state_list - List the state will be added to
187 * DESCRIPTION: Create a new state and push it
189 ******************************************************************************/
192 acpi_ut_create_update_state_and_push(union acpi_operand_object *object,
194 union acpi_generic_state **state_list)
196 union acpi_generic_state *state;
198 ACPI_FUNCTION_ENTRY();
200 /* Ignore null objects; these are expected */
206 state = acpi_ut_create_update_state(object, action);
208 return (AE_NO_MEMORY);
211 acpi_ut_push_generic_state(state_list, state);
215 /*******************************************************************************
217 * FUNCTION: acpi_ut_walk_package_tree
219 * PARAMETERS: source_object - The package to walk
220 * target_object - Target object (if package is being copied)
221 * walk_callback - Called once for each package element
222 * context - Passed to the callback function
226 * DESCRIPTION: Walk through a package
228 ******************************************************************************/
231 acpi_ut_walk_package_tree(union acpi_operand_object *source_object,
233 acpi_pkg_callback walk_callback, void *context)
235 acpi_status status = AE_OK;
236 union acpi_generic_state *state_list = NULL;
237 union acpi_generic_state *state;
239 union acpi_operand_object *this_source_obj;
241 ACPI_FUNCTION_TRACE(ut_walk_package_tree);
243 state = acpi_ut_create_pkg_state(source_object, target_object, 0);
245 return_ACPI_STATUS(AE_NO_MEMORY);
250 /* Get one element of the package */
252 this_index = state->pkg.index;
253 this_source_obj = (union acpi_operand_object *)
254 state->pkg.source_object->package.elements[this_index];
258 * 1) An uninitialized package element. It is completely
259 * legal to declare a package and leave it uninitialized
260 * 2) Not an internal object - can be a namespace node instead
261 * 3) Any type other than a package. Packages are handled in else
264 if ((!this_source_obj) ||
265 (ACPI_GET_DESCRIPTOR_TYPE(this_source_obj) !=
266 ACPI_DESC_TYPE_OPERAND)
267 || (this_source_obj->common.type != ACPI_TYPE_PACKAGE)) {
269 walk_callback(ACPI_COPY_TYPE_SIMPLE,
270 this_source_obj, state, context);
271 if (ACPI_FAILURE(status)) {
272 return_ACPI_STATUS(status);
276 while (state->pkg.index >=
277 state->pkg.source_object->package.count) {
279 * We've handled all of the objects at this level, This means
280 * that we have just completed a package. That package may
281 * have contained one or more packages itself.
283 * Delete this state and pop the previous state (package).
285 acpi_ut_delete_generic_state(state);
286 state = acpi_ut_pop_generic_state(&state_list);
288 /* Finished when there are no more states */
292 * We have handled all of the objects in the top level
293 * package just add the length of the package objects
296 return_ACPI_STATUS(AE_OK);
300 * Go back up a level and move the index past the just
301 * completed package object.
306 /* This is a subobject of type package */
309 walk_callback(ACPI_COPY_TYPE_PACKAGE,
310 this_source_obj, state, context);
311 if (ACPI_FAILURE(status)) {
312 return_ACPI_STATUS(status);
316 * Push the current state and create a new one
317 * The callback above returned a new target package object.
319 acpi_ut_push_generic_state(&state_list, state);
320 state = acpi_ut_create_pkg_state(this_source_obj,
325 /* Free any stacked Update State objects */
329 acpi_ut_pop_generic_state
331 acpi_ut_delete_generic_state(state);
333 return_ACPI_STATUS(AE_NO_MEMORY);
338 /* We should never get here */
340 return_ACPI_STATUS(AE_AML_INTERNAL);
343 #ifdef ACPI_DEBUG_OUTPUT
344 /*******************************************************************************
346 * FUNCTION: acpi_ut_display_init_pathname
348 * PARAMETERS: type - Object type of the node
349 * obj_handle - Handle whose pathname will be displayed
350 * path - Additional path string to be appended.
351 * (NULL if no extra path)
353 * RETURN: acpi_status
355 * DESCRIPTION: Display full pathname of an object, DEBUG ONLY
357 ******************************************************************************/
360 acpi_ut_display_init_pathname(u8 type,
361 struct acpi_namespace_node *obj_handle,
365 struct acpi_buffer buffer;
367 ACPI_FUNCTION_ENTRY();
369 /* Only print the path if the appropriate debug level is enabled */
371 if (!(acpi_dbg_level & ACPI_LV_INIT_NAMES)) {
375 /* Get the full pathname to the node */
377 buffer.length = ACPI_ALLOCATE_LOCAL_BUFFER;
378 status = acpi_ns_handle_to_pathname(obj_handle, &buffer);
379 if (ACPI_FAILURE(status)) {
383 /* Print what we're doing */
386 case ACPI_TYPE_METHOD:
388 acpi_os_printf("Executing ");
393 acpi_os_printf("Initializing ");
397 /* Print the object type and pathname */
399 acpi_os_printf("%-12s %s",
400 acpi_ut_get_type_name(type), (char *)buffer.pointer);
402 /* Extra path is used to append names like _STA, _INI, etc. */
405 acpi_os_printf(".%s", path);
407 acpi_os_printf("\n");
409 ACPI_FREE(buffer.pointer);