[mirror_ubuntu-hirsute-kernel.git] / drivers / acpi / acpica / pstree.c

/******************************************************************************
 *
 * Module Name: pstree - Parser op tree manipulation/traversal/search
 *
 *****************************************************************************/

/*
 * Copyright (C) 2000 - 2018, Intel Corp.
 * 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.
 */

#include <acpi/acpi.h>
#include "accommon.h"
#include "acparser.h"
#include "amlcode.h"
#include "acconvert.h"

#define _COMPONENT          ACPI_PARSER
ACPI_MODULE_NAME("pstree")

/* Local prototypes */
#ifdef ACPI_OBSOLETE_FUNCTIONS
union acpi_parse_object *acpi_ps_get_child(union acpi_parse_object *op);
#endif

/*******************************************************************************
 *
 * FUNCTION:    acpi_ps_get_arg
 *
 * PARAMETERS:  op              - Get an argument for this op
 *              argn            - Nth argument to get
 *
 * RETURN:      The argument (as an Op object). NULL if argument does not exist
 *
 * DESCRIPTION: Get the specified op's argument.
 *
 ******************************************************************************/

union acpi_parse_object *acpi_ps_get_arg(union acpi_parse_object *op, u32 argn)
{
	union acpi_parse_object *arg = NULL;
	const struct acpi_opcode_info *op_info;

	ACPI_FUNCTION_ENTRY();

/*
	if (Op->Common.aml_opcode == AML_INT_CONNECTION_OP)
	{
		return (Op->Common.Value.Arg);
	}
*/
	/* Get the info structure for this opcode */

	op_info = acpi_ps_get_opcode_info(op->common.aml_opcode);
	if (op_info->class == AML_CLASS_UNKNOWN) {

		/* Invalid opcode or ASCII character */

		return (NULL);
	}

	/* Check if this opcode requires argument sub-objects */

	if (!(op_info->flags & AML_HAS_ARGS)) {

		/* Has no linked argument objects */

		return (NULL);
	}

	/* Get the requested argument object */

	arg = op->common.value.arg;
	while (arg && argn) {
		argn--;
		arg = arg->common.next;
	}

	return (arg);
}

/*******************************************************************************
 *
 * FUNCTION:    acpi_ps_append_arg
 *
 * PARAMETERS:  op              - Append an argument to this Op.
 *              arg             - Argument Op to append
 *
 * RETURN:      None.
 *
 * DESCRIPTION: Append an argument to an op's argument list (a NULL arg is OK)
 *
 ******************************************************************************/

void
acpi_ps_append_arg(union acpi_parse_object *op, union acpi_parse_object *arg)
{
	union acpi_parse_object *prev_arg;
	const struct acpi_opcode_info *op_info;

	ACPI_FUNCTION_TRACE(ps_append_arg);

	if (!op) {
		return_VOID;
	}

	/* Get the info structure for this opcode */

	op_info = acpi_ps_get_opcode_info(op->common.aml_opcode);
	if (op_info->class == AML_CLASS_UNKNOWN) {

		/* Invalid opcode */

		ACPI_ERROR((AE_INFO, "Invalid AML Opcode: 0x%2.2X",
			    op->common.aml_opcode));
		return_VOID;
	}

	/* Check if this opcode requires argument sub-objects */

	if (!(op_info->flags & AML_HAS_ARGS)) {

		/* Has no linked argument objects */

		return_VOID;
	}

	/* Append the argument to the linked argument list */

	if (op->common.value.arg) {

		/* Append to existing argument list */

		prev_arg = op->common.value.arg;
		while (prev_arg->common.next) {
			prev_arg = prev_arg->common.next;
		}
		prev_arg->common.next = arg;
	} else {
		/* No argument list, this will be the first argument */

		op->common.value.arg = arg;
	}

	/* Set the parent in this arg and any args linked after it */

	while (arg) {
		arg->common.parent = op;
		arg = arg->common.next;

		op->common.arg_list_length++;
	}

	return_VOID;
}

/*******************************************************************************
 *
 * FUNCTION:    acpi_ps_get_depth_next
 *
 * PARAMETERS:  origin          - Root of subtree to search
 *              op              - Last (previous) Op that was found
 *
 * RETURN:      Next Op found in the search.
 *
 * DESCRIPTION: Get next op in tree (walking the tree in depth-first order)
 *              Return NULL when reaching "origin" or when walking up from root
 *
 ******************************************************************************/

union acpi_parse_object *acpi_ps_get_depth_next(union acpi_parse_object *origin,
						union acpi_parse_object *op)
{
	union acpi_parse_object *next = NULL;
	union acpi_parse_object *parent;
	union acpi_parse_object *arg;

	ACPI_FUNCTION_ENTRY();

	if (!op) {
		return (NULL);
	}

	/* Look for an argument or child */

	next = acpi_ps_get_arg(op, 0);
	if (next) {
		ASL_CV_LABEL_FILENODE(next);
		return (next);
	}

	/* Look for a sibling */

	next = op->common.next;
	if (next) {
		ASL_CV_LABEL_FILENODE(next);
		return (next);
	}

	/* Look for a sibling of parent */

	parent = op->common.parent;

	while (parent) {
		arg = acpi_ps_get_arg(parent, 0);
		while (arg && (arg != origin) && (arg != op)) {

			ASL_CV_LABEL_FILENODE(arg);
			arg = arg->common.next;
		}

		if (arg == origin) {

			/* Reached parent of origin, end search */

			return (NULL);
		}

		if (parent->common.next) {

			/* Found sibling of parent */

			ASL_CV_LABEL_FILENODE(parent->common.next);
			return (parent->common.next);
		}

		op = parent;
		parent = parent->common.parent;
	}

	ASL_CV_LABEL_FILENODE(next);
	return (next);
}

#ifdef ACPI_OBSOLETE_FUNCTIONS
/*******************************************************************************
 *
 * FUNCTION:    acpi_ps_get_child
 *
 * PARAMETERS:  op              - Get the child of this Op
 *
 * RETURN:      Child Op, Null if none is found.
 *
 * DESCRIPTION: Get op's children or NULL if none
 *
 ******************************************************************************/

union acpi_parse_object *acpi_ps_get_child(union acpi_parse_object *op)
{
	union acpi_parse_object *child = NULL;

	ACPI_FUNCTION_ENTRY();

	switch (op->common.aml_opcode) {
	case AML_SCOPE_OP:
	case AML_ELSE_OP:
	case AML_DEVICE_OP:
	case AML_THERMAL_ZONE_OP:
	case AML_INT_METHODCALL_OP:

		child = acpi_ps_get_arg(op, 0);
		break;

	case AML_BUFFER_OP:
	case AML_PACKAGE_OP:
	case AML_METHOD_OP:
	case AML_IF_OP:
	case AML_WHILE_OP:
	case AML_FIELD_OP:

		child = acpi_ps_get_arg(op, 1);
		break;

	case AML_POWER_RESOURCE_OP:
	case AML_INDEX_FIELD_OP:

		child = acpi_ps_get_arg(op, 2);
		break;

	case AML_PROCESSOR_OP:
	case AML_BANK_FIELD_OP:

		child = acpi_ps_get_arg(op, 3);
		break;

	default:

		/* All others have no children */

		break;
	}

	return (child);
}
#endif
Commit	Line	Data
1da177e4 LT	1	/******************************************************************************
	2	*
	3	* Module Name: pstree - Parser op tree manipulation/traversal/search
	4	*
	5	*****************************************************************************/
	6
	7	/*
da6f8320	8	* Copyright (C) 2000 - 2018, 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	44	#include <acpi/acpi.h>
e2f7a777 LB	45	#include "accommon.h"
	46	#include "acparser.h"
	47	#include "amlcode.h"
9cf7adec	48	#include "acconvert.h"
1da177e4 LT	49
1da177e4 LT	50	#define _COMPONENT ACPI_PARSER
4be44fcd	51	ACPI_MODULE_NAME("pstree")
1da177e4	52
44f6c012	53	/* Local prototypes */
44f6c012	54	#ifdef ACPI_OBSOLETE_FUNCTIONS
4be44fcd	55	union acpi_parse_object acpi_ps_get_child(union acpi_parse_object op);
44f6c012 RM	56	#endif
44f6c012 RM	57
1da177e4 LT	58	/*******************************************************************************
	59	*
	60	* FUNCTION: acpi_ps_get_arg
	61	*
ba494bee BM	62	* PARAMETERS: op - Get an argument for this op
ba494bee BM	63	* argn - Nth argument to get
1da177e4	64	*
44f6c012	65	* RETURN: The argument (as an Op object). NULL if argument does not exist
1da177e4 LT	66	*
	67	* DESCRIPTION: Get the specified op's argument.
	68	*
	69	******************************************************************************/
	70
4be44fcd	71	union acpi_parse_object acpi_ps_get_arg(union acpi_parse_object op, u32 argn)
1da177e4	72	{
4be44fcd LB	73	union acpi_parse_object *arg = NULL;
4be44fcd LB	74	const struct acpi_opcode_info *op_info;
1da177e4	75
4be44fcd	76	ACPI_FUNCTION_ENTRY();
1da177e4	77
9ce81784 BM	78	/*
	79	if (Op->Common.aml_opcode == AML_INT_CONNECTION_OP)
	80	{
	81	return (Op->Common.Value.Arg);
	82	}
	83	*/
1da177e4 LT	84	/* Get the info structure for this opcode */
1da177e4 LT	85
4be44fcd	86	op_info = acpi_ps_get_opcode_info(op->common.aml_opcode);
1da177e4	87	if (op_info->class == AML_CLASS_UNKNOWN) {
52fc0b02	88
1da177e4 LT	89	/* Invalid opcode or ASCII character */
	90
	91	return (NULL);
	92	}
	93
	94	/* Check if this opcode requires argument sub-objects */
	95
	96	if (!(op_info->flags & AML_HAS_ARGS)) {
52fc0b02	97
1da177e4 LT	98	/* Has no linked argument objects */
	99
	100	return (NULL);
	101	}
	102
	103	/* Get the requested argument object */
	104
	105	arg = op->common.value.arg;
	106	while (arg && argn) {
	107	argn--;
	108	arg = arg->common.next;
	109	}
	110
	111	return (arg);
	112	}
	113
1da177e4 LT	114	/*******************************************************************************
	115	*
	116	* FUNCTION: acpi_ps_append_arg
	117	*
ba494bee BM	118	* PARAMETERS: op - Append an argument to this Op.
ba494bee BM	119	* arg - Argument Op to append
1da177e4 LT	120	*
	121	* RETURN: None.
	122	*
	123	* DESCRIPTION: Append an argument to an op's argument list (a NULL arg is OK)
	124	*
	125	******************************************************************************/
	126
	127	void
4be44fcd	128	acpi_ps_append_arg(union acpi_parse_object op, union acpi_parse_object arg)
1da177e4	129	{
4be44fcd LB	130	union acpi_parse_object *prev_arg;
4be44fcd LB	131	const struct acpi_opcode_info *op_info;
1da177e4	132
ce87e09d	133	ACPI_FUNCTION_TRACE(ps_append_arg);
1da177e4 LT	134
1da177e4 LT	135	if (!op) {
ce87e09d	136	return_VOID;
1da177e4 LT	137	}
	138
	139	/* Get the info structure for this opcode */
	140
4be44fcd	141	op_info = acpi_ps_get_opcode_info(op->common.aml_opcode);
1da177e4	142	if (op_info->class == AML_CLASS_UNKNOWN) {
52fc0b02	143
1da177e4 LT	144	/* Invalid opcode */
1da177e4 LT	145
b8e4d893 BM	146	ACPI_ERROR((AE_INFO, "Invalid AML Opcode: 0x%2.2X",
b8e4d893 BM	147	op->common.aml_opcode));
ce87e09d	148	return_VOID;
1da177e4 LT	149	}
	150
	151	/* Check if this opcode requires argument sub-objects */
	152
	153	if (!(op_info->flags & AML_HAS_ARGS)) {
52fc0b02	154
1da177e4 LT	155	/* Has no linked argument objects */
1da177e4 LT	156
ce87e09d	157	return_VOID;
1da177e4 LT	158	}
1da177e4 LT	159
1da177e4 LT	160	/* Append the argument to the linked argument list */
	161
	162	if (op->common.value.arg) {
52fc0b02	163
1da177e4 LT	164	/* Append to existing argument list */
	165
	166	prev_arg = op->common.value.arg;
	167	while (prev_arg->common.next) {
	168	prev_arg = prev_arg->common.next;
	169	}
	170	prev_arg->common.next = arg;
4be44fcd	171	} else {
1da177e4 LT	172	/* No argument list, this will be the first argument */
	173
	174	op->common.value.arg = arg;
	175	}
	176
1da177e4 LT	177	/* Set the parent in this arg and any args linked after it */
	178
	179	while (arg) {
	180	arg->common.parent = op;
	181	arg = arg->common.next;
4e3156b1 BM	182
4e3156b1 BM	183	op->common.arg_list_length++;
1da177e4	184	}
ce87e09d BM	185
ce87e09d BM	186	return_VOID;
1da177e4 LT	187	}
1da177e4 LT	188
1da177e4 LT	189	/*******************************************************************************
	190	*
	191	* FUNCTION: acpi_ps_get_depth_next
	192	*
ba494bee BM	193	* PARAMETERS: origin - Root of subtree to search
ba494bee BM	194	* op - Last (previous) Op that was found
1da177e4 LT	195	*
	196	* RETURN: Next Op found in the search.
	197	*
	198	* DESCRIPTION: Get next op in tree (walking the tree in depth-first order)
	199	* Return NULL when reaching "origin" or when walking up from root
	200	*
	201	******************************************************************************/
	202
4be44fcd LB	203	union acpi_parse_object acpi_ps_get_depth_next(union acpi_parse_object origin,
4be44fcd LB	204	union acpi_parse_object *op)
1da177e4	205	{
4be44fcd LB	206	union acpi_parse_object *next = NULL;
	207	union acpi_parse_object *parent;
	208	union acpi_parse_object *arg;
1da177e4	209
4be44fcd	210	ACPI_FUNCTION_ENTRY();
1da177e4 LT	211
	212	if (!op) {
	213	return (NULL);
	214	}
	215
44f6c012	216	/* Look for an argument or child */
1da177e4	217
4be44fcd	218	next = acpi_ps_get_arg(op, 0);
1da177e4	219	if (next) {
9cf7adec	220	ASL_CV_LABEL_FILENODE(next);
1da177e4 LT	221	return (next);
	222	}
	223
44f6c012	224	/* Look for a sibling */
1da177e4 LT	225
	226	next = op->common.next;
	227	if (next) {
9cf7adec	228	ASL_CV_LABEL_FILENODE(next);
1da177e4 LT	229	return (next);
	230	}
	231
44f6c012	232	/* Look for a sibling of parent */
1da177e4 LT	233
	234	parent = op->common.parent;
	235
	236	while (parent) {
4be44fcd	237	arg = acpi_ps_get_arg(parent, 0);
1da177e4	238	while (arg && (arg != origin) && (arg != op)) {
9cf7adec BM	239
9cf7adec BM	240	ASL_CV_LABEL_FILENODE(arg);
1da177e4 LT	241	arg = arg->common.next;
	242	}
	243
	244	if (arg == origin) {
52fc0b02	245
44f6c012	246	/* Reached parent of origin, end search */
1da177e4 LT	247
	248	return (NULL);
	249	}
	250
	251	if (parent->common.next) {
52fc0b02	252
44f6c012	253	/* Found sibling of parent */
1da177e4	254
9cf7adec	255	ASL_CV_LABEL_FILENODE(parent->common.next);
1da177e4 LT	256	return (parent->common.next);
	257	}
	258
	259	op = parent;
	260	parent = parent->common.parent;
	261	}
	262
9cf7adec	263	ASL_CV_LABEL_FILENODE(next);
1da177e4 LT	264	return (next);
	265	}
	266
44f6c012 RM	267	#ifdef ACPI_OBSOLETE_FUNCTIONS
	268	/*******************************************************************************
	269	*
	270	* FUNCTION: acpi_ps_get_child
	271	*
ba494bee	272	* PARAMETERS: op - Get the child of this Op
44f6c012 RM	273	*
	274	* RETURN: Child Op, Null if none is found.
	275	*
	276	* DESCRIPTION: Get op's children or NULL if none
	277	*
	278	******************************************************************************/
	279
4be44fcd	280	union acpi_parse_object acpi_ps_get_child(union acpi_parse_object op)
44f6c012	281	{
4be44fcd	282	union acpi_parse_object *child = NULL;
44f6c012	283
4be44fcd	284	ACPI_FUNCTION_ENTRY();
44f6c012 RM	285
	286	switch (op->common.aml_opcode) {
	287	case AML_SCOPE_OP:
	288	case AML_ELSE_OP:
	289	case AML_DEVICE_OP:
	290	case AML_THERMAL_ZONE_OP:
	291	case AML_INT_METHODCALL_OP:
	292
4be44fcd	293	child = acpi_ps_get_arg(op, 0);
44f6c012 RM	294	break;
44f6c012 RM	295
44f6c012 RM	296	case AML_BUFFER_OP:
	297	case AML_PACKAGE_OP:
	298	case AML_METHOD_OP:
	299	case AML_IF_OP:
	300	case AML_WHILE_OP:
	301	case AML_FIELD_OP:
	302
4be44fcd	303	child = acpi_ps_get_arg(op, 1);
44f6c012 RM	304	break;
44f6c012 RM	305
9ff5a21a	306	case AML_POWER_RESOURCE_OP:
44f6c012 RM	307	case AML_INDEX_FIELD_OP:
44f6c012 RM	308
4be44fcd	309	child = acpi_ps_get_arg(op, 2);
44f6c012 RM	310	break;
44f6c012 RM	311
44f6c012 RM	312	case AML_PROCESSOR_OP:
	313	case AML_BANK_FIELD_OP:
	314
4be44fcd	315	child = acpi_ps_get_arg(op, 3);
44f6c012 RM	316	break;
44f6c012 RM	317
44f6c012	318	default:
1d1ea1b7	319
44f6c012	320	/* All others have no children */
1d1ea1b7	321
44f6c012 RM	322	break;
	323	}
	324
	325	return (child);
	326	}
	327	#endif