195857638SErik Schmauss // SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0
295b482a8SLen Brown /*******************************************************************************
395b482a8SLen Brown *
495b482a8SLen Brown * Module Name: utmisc - common utility procedures
595b482a8SLen Brown *
695b482a8SLen Brown ******************************************************************************/
795b482a8SLen Brown
895b482a8SLen Brown #include <acpi/acpi.h>
9e2f7a777SLen Brown #include "accommon.h"
10e2f7a777SLen Brown #include "acnamesp.h"
1195b482a8SLen Brown
1295b482a8SLen Brown #define _COMPONENT ACPI_UTILITIES
1395b482a8SLen Brown ACPI_MODULE_NAME("utmisc")
1495b482a8SLen Brown
15c6e1733eSBob Moore /*******************************************************************************
16c6e1733eSBob Moore *
1715b8dd53SBob Moore * FUNCTION: acpi_ut_is_pci_root_bridge
1815b8dd53SBob Moore *
19ba494beeSBob Moore * PARAMETERS: id - The HID/CID in string format
2015b8dd53SBob Moore *
2115b8dd53SBob Moore * RETURN: TRUE if the Id is a match for a PCI/PCI-Express Root Bridge
2215b8dd53SBob Moore *
2315b8dd53SBob Moore * DESCRIPTION: Determine if the input ID is a PCI Root Bridge ID.
2415b8dd53SBob Moore *
2515b8dd53SBob Moore ******************************************************************************/
acpi_ut_is_pci_root_bridge(char * id)2615b8dd53SBob Moore u8 acpi_ut_is_pci_root_bridge(char *id)
2715b8dd53SBob Moore {
2815b8dd53SBob Moore
2915b8dd53SBob Moore /*
3015b8dd53SBob Moore * Check if this is a PCI root bridge.
3115b8dd53SBob Moore * ACPI 3.0+: check for a PCI Express root also.
3215b8dd53SBob Moore */
334fa4616eSBob Moore if (!(strcmp(id,
3415b8dd53SBob Moore PCI_ROOT_HID_STRING)) ||
354fa4616eSBob Moore !(strcmp(id, PCI_EXPRESS_ROOT_HID_STRING))) {
3615b8dd53SBob Moore return (TRUE);
3715b8dd53SBob Moore }
3815b8dd53SBob Moore
3915b8dd53SBob Moore return (FALSE);
4015b8dd53SBob Moore }
4115b8dd53SBob Moore
4217dd4dcfSBob Moore #if (defined ACPI_ASL_COMPILER || defined ACPI_EXEC_APP || defined ACPI_NAMES_APP)
4315b8dd53SBob Moore /*******************************************************************************
4415b8dd53SBob Moore *
4595b482a8SLen Brown * FUNCTION: acpi_ut_is_aml_table
4695b482a8SLen Brown *
47ba494beeSBob Moore * PARAMETERS: table - An ACPI table
4895b482a8SLen Brown *
4995b482a8SLen Brown * RETURN: TRUE if table contains executable AML; FALSE otherwise
5095b482a8SLen Brown *
5195b482a8SLen Brown * DESCRIPTION: Check ACPI Signature for a table that contains AML code.
5295b482a8SLen Brown * Currently, these are DSDT,SSDT,PSDT. All other table types are
5395b482a8SLen Brown * data tables that do not contain AML code.
5495b482a8SLen Brown *
5595b482a8SLen Brown ******************************************************************************/
5695b482a8SLen Brown
acpi_ut_is_aml_table(struct acpi_table_header * table)5795b482a8SLen Brown u8 acpi_ut_is_aml_table(struct acpi_table_header *table)
5895b482a8SLen Brown {
5995b482a8SLen Brown
6095b482a8SLen Brown /* These are the only tables that contain executable AML */
6195b482a8SLen Brown
625599fb69SBob Moore if (ACPI_COMPARE_NAMESEG(table->signature, ACPI_SIG_DSDT) ||
635599fb69SBob Moore ACPI_COMPARE_NAMESEG(table->signature, ACPI_SIG_PSDT) ||
645599fb69SBob Moore ACPI_COMPARE_NAMESEG(table->signature, ACPI_SIG_SSDT) ||
655599fb69SBob Moore ACPI_COMPARE_NAMESEG(table->signature, ACPI_SIG_OSDT) ||
6673a049a9SErik Schmauss ACPI_IS_OEM_SIG(table->signature)) {
6795b482a8SLen Brown return (TRUE);
6895b482a8SLen Brown }
6995b482a8SLen Brown
7095b482a8SLen Brown return (FALSE);
7195b482a8SLen Brown }
726306bf88SLv Zheng #endif
7395b482a8SLen Brown
7495b482a8SLen Brown /*******************************************************************************
7595b482a8SLen Brown *
7695b482a8SLen Brown * FUNCTION: acpi_ut_dword_byte_swap
7795b482a8SLen Brown *
78ba494beeSBob Moore * PARAMETERS: value - Value to be converted
7995b482a8SLen Brown *
8095b482a8SLen Brown * RETURN: u32 integer with bytes swapped
8195b482a8SLen Brown *
8295b482a8SLen Brown * DESCRIPTION: Convert a 32-bit value to big-endian (swap the bytes)
8395b482a8SLen Brown *
8495b482a8SLen Brown ******************************************************************************/
8595b482a8SLen Brown
acpi_ut_dword_byte_swap(u32 value)8695b482a8SLen Brown u32 acpi_ut_dword_byte_swap(u32 value)
8795b482a8SLen Brown {
8895b482a8SLen Brown union {
8995b482a8SLen Brown u32 value;
9095b482a8SLen Brown u8 bytes[4];
9195b482a8SLen Brown } out;
9295b482a8SLen Brown union {
9395b482a8SLen Brown u32 value;
9495b482a8SLen Brown u8 bytes[4];
9595b482a8SLen Brown } in;
9695b482a8SLen Brown
9795b482a8SLen Brown ACPI_FUNCTION_ENTRY();
9895b482a8SLen Brown
9995b482a8SLen Brown in.value = value;
10095b482a8SLen Brown
10195b482a8SLen Brown out.bytes[0] = in.bytes[3];
10295b482a8SLen Brown out.bytes[1] = in.bytes[2];
10395b482a8SLen Brown out.bytes[2] = in.bytes[1];
10495b482a8SLen Brown out.bytes[3] = in.bytes[0];
10595b482a8SLen Brown
10695b482a8SLen Brown return (out.value);
10795b482a8SLen Brown }
10895b482a8SLen Brown
10995b482a8SLen Brown /*******************************************************************************
11095b482a8SLen Brown *
11195b482a8SLen Brown * FUNCTION: acpi_ut_set_integer_width
11295b482a8SLen Brown *
11395b482a8SLen Brown * PARAMETERS: Revision From DSDT header
11495b482a8SLen Brown *
11595b482a8SLen Brown * RETURN: None
11695b482a8SLen Brown *
11795b482a8SLen Brown * DESCRIPTION: Set the global integer bit width based upon the revision
11895b482a8SLen Brown * of the DSDT. For Revision 1 and 0, Integers are 32 bits.
11995b482a8SLen Brown * For Revision 2 and above, Integers are 64 bits. Yes, this
12095b482a8SLen Brown * makes a difference.
12195b482a8SLen Brown *
12295b482a8SLen Brown ******************************************************************************/
12395b482a8SLen Brown
acpi_ut_set_integer_width(u8 revision)12495b482a8SLen Brown void acpi_ut_set_integer_width(u8 revision)
12595b482a8SLen Brown {
12695b482a8SLen Brown
12795b482a8SLen Brown if (revision < 2) {
12895b482a8SLen Brown
12995b482a8SLen Brown /* 32-bit case */
13095b482a8SLen Brown
13195b482a8SLen Brown acpi_gbl_integer_bit_width = 32;
13295b482a8SLen Brown acpi_gbl_integer_nybble_width = 8;
13395b482a8SLen Brown acpi_gbl_integer_byte_width = 4;
13495b482a8SLen Brown } else {
13595b482a8SLen Brown /* 64-bit case (ACPI 2.0+) */
13695b482a8SLen Brown
13795b482a8SLen Brown acpi_gbl_integer_bit_width = 64;
13895b482a8SLen Brown acpi_gbl_integer_nybble_width = 16;
13995b482a8SLen Brown acpi_gbl_integer_byte_width = 8;
14095b482a8SLen Brown }
14195b482a8SLen Brown }
14295b482a8SLen Brown
14395b482a8SLen Brown /*******************************************************************************
14495b482a8SLen Brown *
14595b482a8SLen Brown * FUNCTION: acpi_ut_create_update_state_and_push
14695b482a8SLen Brown *
147ba494beeSBob Moore * PARAMETERS: object - Object to be added to the new state
148ba494beeSBob Moore * action - Increment/Decrement
14995b482a8SLen Brown * state_list - List the state will be added to
15095b482a8SLen Brown *
15195b482a8SLen Brown * RETURN: Status
15295b482a8SLen Brown *
15395b482a8SLen Brown * DESCRIPTION: Create a new state and push it
15495b482a8SLen Brown *
15595b482a8SLen Brown ******************************************************************************/
15695b482a8SLen Brown
15795b482a8SLen Brown acpi_status
acpi_ut_create_update_state_and_push(union acpi_operand_object * object,u16 action,union acpi_generic_state ** state_list)15895b482a8SLen Brown acpi_ut_create_update_state_and_push(union acpi_operand_object *object,
15995b482a8SLen Brown u16 action,
16095b482a8SLen Brown union acpi_generic_state **state_list)
16195b482a8SLen Brown {
16295b482a8SLen Brown union acpi_generic_state *state;
16395b482a8SLen Brown
16495b482a8SLen Brown ACPI_FUNCTION_ENTRY();
16595b482a8SLen Brown
16695b482a8SLen Brown /* Ignore null objects; these are expected */
16795b482a8SLen Brown
16895b482a8SLen Brown if (!object) {
16995b482a8SLen Brown return (AE_OK);
17095b482a8SLen Brown }
17195b482a8SLen Brown
17295b482a8SLen Brown state = acpi_ut_create_update_state(object, action);
17395b482a8SLen Brown if (!state) {
17495b482a8SLen Brown return (AE_NO_MEMORY);
17595b482a8SLen Brown }
17695b482a8SLen Brown
17795b482a8SLen Brown acpi_ut_push_generic_state(state_list, state);
17895b482a8SLen Brown return (AE_OK);
17995b482a8SLen Brown }
18095b482a8SLen Brown
18195b482a8SLen Brown /*******************************************************************************
18295b482a8SLen Brown *
18395b482a8SLen Brown * FUNCTION: acpi_ut_walk_package_tree
18495b482a8SLen Brown *
18595b482a8SLen Brown * PARAMETERS: source_object - The package to walk
18695b482a8SLen Brown * target_object - Target object (if package is being copied)
18795b482a8SLen Brown * walk_callback - Called once for each package element
188ba494beeSBob Moore * context - Passed to the callback function
18995b482a8SLen Brown *
19095b482a8SLen Brown * RETURN: Status
19195b482a8SLen Brown *
192a62a7117SBob Moore * DESCRIPTION: Walk through a package, including subpackages
19395b482a8SLen Brown *
19495b482a8SLen Brown ******************************************************************************/
19595b482a8SLen Brown
19695b482a8SLen Brown acpi_status
acpi_ut_walk_package_tree(union acpi_operand_object * source_object,void * target_object,acpi_pkg_callback walk_callback,void * context)19795b482a8SLen Brown acpi_ut_walk_package_tree(union acpi_operand_object *source_object,
19895b482a8SLen Brown void *target_object,
19995b482a8SLen Brown acpi_pkg_callback walk_callback, void *context)
20095b482a8SLen Brown {
20195b482a8SLen Brown acpi_status status = AE_OK;
20295b482a8SLen Brown union acpi_generic_state *state_list = NULL;
20395b482a8SLen Brown union acpi_generic_state *state;
20495b482a8SLen Brown union acpi_operand_object *this_source_obj;
205a62a7117SBob Moore u32 this_index;
20695b482a8SLen Brown
20795b482a8SLen Brown ACPI_FUNCTION_TRACE(ut_walk_package_tree);
20895b482a8SLen Brown
20995b482a8SLen Brown state = acpi_ut_create_pkg_state(source_object, target_object, 0);
21095b482a8SLen Brown if (!state) {
21195b482a8SLen Brown return_ACPI_STATUS(AE_NO_MEMORY);
21295b482a8SLen Brown }
21395b482a8SLen Brown
21495b482a8SLen Brown while (state) {
21595b482a8SLen Brown
21695b482a8SLen Brown /* Get one element of the package */
21795b482a8SLen Brown
21895b482a8SLen Brown this_index = state->pkg.index;
219a62a7117SBob Moore this_source_obj =
22095b482a8SLen Brown state->pkg.source_object->package.elements[this_index];
221a62a7117SBob Moore state->pkg.this_target_obj =
222a62a7117SBob Moore &state->pkg.source_object->package.elements[this_index];
22395b482a8SLen Brown
22495b482a8SLen Brown /*
22595b482a8SLen Brown * Check for:
22695b482a8SLen Brown * 1) An uninitialized package element. It is completely
22795b482a8SLen Brown * legal to declare a package and leave it uninitialized
22895b482a8SLen Brown * 2) Not an internal object - can be a namespace node instead
22995b482a8SLen Brown * 3) Any type other than a package. Packages are handled in else
23095b482a8SLen Brown * case below.
23195b482a8SLen Brown */
23295b482a8SLen Brown if ((!this_source_obj) ||
23395b482a8SLen Brown (ACPI_GET_DESCRIPTOR_TYPE(this_source_obj) !=
2341fad8738SBob Moore ACPI_DESC_TYPE_OPERAND) ||
2351fad8738SBob Moore (this_source_obj->common.type != ACPI_TYPE_PACKAGE)) {
23695b482a8SLen Brown status =
23795b482a8SLen Brown walk_callback(ACPI_COPY_TYPE_SIMPLE,
23895b482a8SLen Brown this_source_obj, state, context);
23995b482a8SLen Brown if (ACPI_FAILURE(status)) {
24095b482a8SLen Brown return_ACPI_STATUS(status);
24195b482a8SLen Brown }
24295b482a8SLen Brown
24395b482a8SLen Brown state->pkg.index++;
24495b482a8SLen Brown while (state->pkg.index >=
24595b482a8SLen Brown state->pkg.source_object->package.count) {
24695b482a8SLen Brown /*
24795b482a8SLen Brown * We've handled all of the objects at this level, This means
24895b482a8SLen Brown * that we have just completed a package. That package may
24995b482a8SLen Brown * have contained one or more packages itself.
25095b482a8SLen Brown *
25195b482a8SLen Brown * Delete this state and pop the previous state (package).
25295b482a8SLen Brown */
25395b482a8SLen Brown acpi_ut_delete_generic_state(state);
25495b482a8SLen Brown state = acpi_ut_pop_generic_state(&state_list);
25595b482a8SLen Brown
25695b482a8SLen Brown /* Finished when there are no more states */
25795b482a8SLen Brown
25895b482a8SLen Brown if (!state) {
25995b482a8SLen Brown /*
26095b482a8SLen Brown * We have handled all of the objects in the top level
26195b482a8SLen Brown * package just add the length of the package objects
26295b482a8SLen Brown * and exit
26395b482a8SLen Brown */
26495b482a8SLen Brown return_ACPI_STATUS(AE_OK);
26595b482a8SLen Brown }
26695b482a8SLen Brown
26795b482a8SLen Brown /*
26895b482a8SLen Brown * Go back up a level and move the index past the just
26995b482a8SLen Brown * completed package object.
27095b482a8SLen Brown */
27195b482a8SLen Brown state->pkg.index++;
27295b482a8SLen Brown }
27395b482a8SLen Brown } else {
27495b482a8SLen Brown /* This is a subobject of type package */
27595b482a8SLen Brown
27695b482a8SLen Brown status =
27795b482a8SLen Brown walk_callback(ACPI_COPY_TYPE_PACKAGE,
27895b482a8SLen Brown this_source_obj, state, context);
27995b482a8SLen Brown if (ACPI_FAILURE(status)) {
28095b482a8SLen Brown return_ACPI_STATUS(status);
28195b482a8SLen Brown }
28295b482a8SLen Brown
28395b482a8SLen Brown /*
28495b482a8SLen Brown * Push the current state and create a new one
28595b482a8SLen Brown * The callback above returned a new target package object.
28695b482a8SLen Brown */
28795b482a8SLen Brown acpi_ut_push_generic_state(&state_list, state);
2881fad8738SBob Moore state =
2891fad8738SBob Moore acpi_ut_create_pkg_state(this_source_obj,
2901fad8738SBob Moore state->pkg.this_target_obj,
2911fad8738SBob Moore 0);
29295b482a8SLen Brown if (!state) {
29395b482a8SLen Brown
29495b482a8SLen Brown /* Free any stacked Update State objects */
29595b482a8SLen Brown
29695b482a8SLen Brown while (state_list) {
29795b482a8SLen Brown state =
29895b482a8SLen Brown acpi_ut_pop_generic_state
29995b482a8SLen Brown (&state_list);
30095b482a8SLen Brown acpi_ut_delete_generic_state(state);
30195b482a8SLen Brown }
30295b482a8SLen Brown return_ACPI_STATUS(AE_NO_MEMORY);
30395b482a8SLen Brown }
30495b482a8SLen Brown }
30595b482a8SLen Brown }
30695b482a8SLen Brown
30795b482a8SLen Brown /* We should never get here */
30895b482a8SLen Brown
309376a588cSBob Moore ACPI_ERROR((AE_INFO, "State list did not terminate correctly"));
310376a588cSBob Moore
31195b482a8SLen Brown return_ACPI_STATUS(AE_AML_INTERNAL);
31295b482a8SLen Brown }
31342f8fb75SBob Moore
31442f8fb75SBob Moore #ifdef ACPI_DEBUG_OUTPUT
31542f8fb75SBob Moore /*******************************************************************************
31642f8fb75SBob Moore *
31742f8fb75SBob Moore * FUNCTION: acpi_ut_display_init_pathname
31842f8fb75SBob Moore *
31942f8fb75SBob Moore * PARAMETERS: type - Object type of the node
32042f8fb75SBob Moore * obj_handle - Handle whose pathname will be displayed
32142f8fb75SBob Moore * path - Additional path string to be appended.
32242f8fb75SBob Moore * (NULL if no extra path)
32342f8fb75SBob Moore *
32442f8fb75SBob Moore * RETURN: acpi_status
32542f8fb75SBob Moore *
32642f8fb75SBob Moore * DESCRIPTION: Display full pathname of an object, DEBUG ONLY
32742f8fb75SBob Moore *
32842f8fb75SBob Moore ******************************************************************************/
32942f8fb75SBob Moore
33042f8fb75SBob Moore void
acpi_ut_display_init_pathname(u8 type,struct acpi_namespace_node * obj_handle,const char * path)33142f8fb75SBob Moore acpi_ut_display_init_pathname(u8 type,
33242f8fb75SBob Moore struct acpi_namespace_node *obj_handle,
3330dfaaa3dSBob Moore const char *path)
33442f8fb75SBob Moore {
33542f8fb75SBob Moore acpi_status status;
33642f8fb75SBob Moore struct acpi_buffer buffer;
33742f8fb75SBob Moore
33842f8fb75SBob Moore ACPI_FUNCTION_ENTRY();
33942f8fb75SBob Moore
34042f8fb75SBob Moore /* Only print the path if the appropriate debug level is enabled */
34142f8fb75SBob Moore
34242f8fb75SBob Moore if (!(acpi_dbg_level & ACPI_LV_INIT_NAMES)) {
34342f8fb75SBob Moore return;
34442f8fb75SBob Moore }
34542f8fb75SBob Moore
34642f8fb75SBob Moore /* Get the full pathname to the node */
34742f8fb75SBob Moore
34842f8fb75SBob Moore buffer.length = ACPI_ALLOCATE_LOCAL_BUFFER;
3492e5321cbSLv Zheng status = acpi_ns_handle_to_pathname(obj_handle, &buffer, TRUE);
35042f8fb75SBob Moore if (ACPI_FAILURE(status)) {
35142f8fb75SBob Moore return;
35242f8fb75SBob Moore }
35342f8fb75SBob Moore
35442f8fb75SBob Moore /* Print what we're doing */
35542f8fb75SBob Moore
35642f8fb75SBob Moore switch (type) {
35742f8fb75SBob Moore case ACPI_TYPE_METHOD:
3581d1ea1b7SChao Guan
35942f8fb75SBob Moore acpi_os_printf("Executing ");
36042f8fb75SBob Moore break;
36142f8fb75SBob Moore
36242f8fb75SBob Moore default:
3631d1ea1b7SChao Guan
36442f8fb75SBob Moore acpi_os_printf("Initializing ");
36542f8fb75SBob Moore break;
36642f8fb75SBob Moore }
36742f8fb75SBob Moore
36842f8fb75SBob Moore /* Print the object type and pathname */
36942f8fb75SBob Moore
37042f8fb75SBob Moore acpi_os_printf("%-12s %s",
37142f8fb75SBob Moore acpi_ut_get_type_name(type), (char *)buffer.pointer);
37242f8fb75SBob Moore
37342f8fb75SBob Moore /* Extra path is used to append names like _STA, _INI, etc. */
37442f8fb75SBob Moore
37542f8fb75SBob Moore if (path) {
37642f8fb75SBob Moore acpi_os_printf(".%s", path);
37742f8fb75SBob Moore }
37842f8fb75SBob Moore acpi_os_printf("\n");
37942f8fb75SBob Moore
38042f8fb75SBob Moore ACPI_FREE(buffer.pointer);
38142f8fb75SBob Moore }
38242f8fb75SBob Moore #endif
383