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

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

/*
 * Copyright (C) 2000 - 2017, 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"

#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) {
		return (next);
	}

	/* Look for a sibling */

	next = op->common.next;
	if (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)) {
			arg = arg->common.next;
		}

		if (arg == origin) {

			/* Reached parent of origin, end search */

			return (NULL);
		}

		if (parent->common.next) {

			/* Found sibling of parent */

			return (parent->common.next);
		}

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

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