[GitHub/mt8127/android_kernel_alcatel_ttab.git] / drivers / acpi / acpica / psscope.c

/******************************************************************************
 *
 * Module Name: psscope - Parser scope stack management routines
 *
 *****************************************************************************/

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

#define _COMPONENT          ACPI_PARSER
ACPI_MODULE_NAME("psscope")

/*******************************************************************************
 *
 * FUNCTION:    acpi_ps_get_parent_scope
 *
 * PARAMETERS:  parser_state        - Current parser state object
 *
 * RETURN:      Pointer to an Op object
 *
 * DESCRIPTION: Get parent of current op being parsed
 *
 ******************************************************************************/
union acpi_parse_object *acpi_ps_get_parent_scope(struct acpi_parse_state
						  *parser_state)
{

	return (parser_state->scope->parse_scope.op);
}

/*******************************************************************************
 *
 * FUNCTION:    acpi_ps_has_completed_scope
 *
 * PARAMETERS:  parser_state        - Current parser state object
 *
 * RETURN:      Boolean, TRUE = scope completed.
 *
 * DESCRIPTION: Is parsing of current argument complete?  Determined by
 *              1) AML pointer is at or beyond the end of the scope
 *              2) The scope argument count has reached zero.
 *
 ******************************************************************************/

u8 acpi_ps_has_completed_scope(struct acpi_parse_state * parser_state)
{

	return ((u8)
		((parser_state->aml >= parser_state->scope->parse_scope.arg_end
		  || !parser_state->scope->parse_scope.arg_count)));
}

/*******************************************************************************
 *
 * FUNCTION:    acpi_ps_init_scope
 *
 * PARAMETERS:  parser_state        - Current parser state object
 *              root                - the Root Node of this new scope
 *
 * RETURN:      Status
 *
 * DESCRIPTION: Allocate and init a new scope object
 *
 ******************************************************************************/

acpi_status
acpi_ps_init_scope(struct acpi_parse_state * parser_state,
		   union acpi_parse_object * root_op)
{
	union acpi_generic_state *scope;

	ACPI_FUNCTION_TRACE_PTR(ps_init_scope, root_op);

	scope = acpi_ut_create_generic_state();
	if (!scope) {
		return_ACPI_STATUS(AE_NO_MEMORY);
	}

	scope->common.descriptor_type = ACPI_DESC_TYPE_STATE_RPSCOPE;
	scope->parse_scope.op = root_op;
	scope->parse_scope.arg_count = ACPI_VAR_ARGS;
	scope->parse_scope.arg_end = parser_state->aml_end;
	scope->parse_scope.pkg_end = parser_state->aml_end;

	parser_state->scope = scope;
	parser_state->start_op = root_op;

	return_ACPI_STATUS(AE_OK);
}

/*******************************************************************************
 *
 * FUNCTION:    acpi_ps_push_scope
 *
 * PARAMETERS:  parser_state        - Current parser state object
 *              op                  - Current op to be pushed
 *              remaining_args      - List of args remaining
 *              arg_count           - Fixed or variable number of args
 *
 * RETURN:      Status
 *
 * DESCRIPTION: Push current op to begin parsing its argument
 *
 ******************************************************************************/

acpi_status
acpi_ps_push_scope(struct acpi_parse_state *parser_state,
		   union acpi_parse_object *op,
		   u32 remaining_args, u32 arg_count)
{
	union acpi_generic_state *scope;

	ACPI_FUNCTION_TRACE_PTR(ps_push_scope, op);

	scope = acpi_ut_create_generic_state();
	if (!scope) {
		return_ACPI_STATUS(AE_NO_MEMORY);
	}

	scope->common.descriptor_type = ACPI_DESC_TYPE_STATE_PSCOPE;
	scope->parse_scope.op = op;
	scope->parse_scope.arg_list = remaining_args;
	scope->parse_scope.arg_count = arg_count;
	scope->parse_scope.pkg_end = parser_state->pkg_end;

	/* Push onto scope stack */

	acpi_ut_push_generic_state(&parser_state->scope, scope);

	if (arg_count == ACPI_VAR_ARGS) {

		/* Multiple arguments */

		scope->parse_scope.arg_end = parser_state->pkg_end;
	} else {
		/* Single argument */

		scope->parse_scope.arg_end = ACPI_TO_POINTER(ACPI_MAX_PTR);
	}

	return_ACPI_STATUS(AE_OK);
}

/*******************************************************************************
 *
 * FUNCTION:    acpi_ps_pop_scope
 *
 * PARAMETERS:  parser_state        - Current parser state object
 *              op                  - Where the popped op is returned
 *              arg_list            - Where the popped "next argument" is
 *                                    returned
 *              arg_count           - Count of objects in arg_list
 *
 * RETURN:      Status
 *
 * DESCRIPTION: Return to parsing a previous op
 *
 ******************************************************************************/

void
acpi_ps_pop_scope(struct acpi_parse_state *parser_state,
		  union acpi_parse_object **op, u32 * arg_list, u32 * arg_count)
{
	union acpi_generic_state *scope = parser_state->scope;

	ACPI_FUNCTION_TRACE(ps_pop_scope);

	/* Only pop the scope if there is in fact a next scope */

	if (scope->common.next) {
		scope = acpi_ut_pop_generic_state(&parser_state->scope);

		/* Return to parsing previous op */

		*op = scope->parse_scope.op;
		*arg_list = scope->parse_scope.arg_list;
		*arg_count = scope->parse_scope.arg_count;
		parser_state->pkg_end = scope->parse_scope.pkg_end;

		/* All done with this scope state structure */

		acpi_ut_delete_generic_state(scope);
	} else {
		/* Empty parse stack, prepare to fetch next opcode */

		*op = NULL;
		*arg_list = 0;
		*arg_count = 0;
	}

	ACPI_DEBUG_PRINT((ACPI_DB_PARSE,
			  "Popped Op %p Args %X\n", *op, *arg_count));
	return_VOID;
}

/*******************************************************************************
 *
 * FUNCTION:    acpi_ps_cleanup_scope
 *
 * PARAMETERS:  parser_state        - Current parser state object
 *
 * RETURN:      None
 *
 * DESCRIPTION: Destroy available list, remaining stack levels, and return
 *              root scope
 *
 ******************************************************************************/

void acpi_ps_cleanup_scope(struct acpi_parse_state *parser_state)
{
	union acpi_generic_state *scope;

	ACPI_FUNCTION_TRACE_PTR(ps_cleanup_scope, parser_state);

	if (!parser_state) {
		return_VOID;
	}

	/* Delete anything on the scope stack */

	while (parser_state->scope) {
		scope = acpi_ut_pop_generic_state(&parser_state->scope);
		acpi_ut_delete_generic_state(scope);
	}

	return_VOID;
}
Commit	Line	Data
1da177e4 LT	1	/******************************************************************************
	2	*
	3	* Module Name: psscope - Parser scope stack management routines
	4	*
	5	*****************************************************************************/
	6
	7	/*
25f044e6	8	* Copyright (C) 2000 - 2013, 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"
e2f7a777 LB	46	#include "acparser.h"
1da177e4 LT	47
1da177e4 LT	48	#define _COMPONENT ACPI_PARSER
4be44fcd	49	ACPI_MODULE_NAME("psscope")
1da177e4 LT	50
	51	/*******************************************************************************
	52	*
	53	* FUNCTION: acpi_ps_get_parent_scope
	54	*
	55	* PARAMETERS: parser_state - Current parser state object
	56	*
	57	* RETURN: Pointer to an Op object
	58	*
	59	* DESCRIPTION: Get parent of current op being parsed
	60	*
	61	******************************************************************************/
4be44fcd LB	62	union acpi_parse_object *acpi_ps_get_parent_scope(struct acpi_parse_state
4be44fcd LB	63	*parser_state)
1da177e4	64	{
44f6c012	65
1da177e4 LT	66	return (parser_state->scope->parse_scope.op);
	67	}
	68
1da177e4 LT	69	/*******************************************************************************
	70	*
	71	* FUNCTION: acpi_ps_has_completed_scope
	72	*
	73	* PARAMETERS: parser_state - Current parser state object
	74	*
	75	* RETURN: Boolean, TRUE = scope completed.
	76	*
	77	* DESCRIPTION: Is parsing of current argument complete? Determined by
	78	* 1) AML pointer is at or beyond the end of the scope
	79	* 2) The scope argument count has reached zero.
	80	*
	81	******************************************************************************/
	82
4be44fcd	83	u8 acpi_ps_has_completed_scope(struct acpi_parse_state * parser_state)
1da177e4	84	{
44f6c012 RM	85
44f6c012 RM	86	return ((u8)
4be44fcd LB	87	((parser_state->aml >= parser_state->scope->parse_scope.arg_end
4be44fcd LB	88	\|\| !parser_state->scope->parse_scope.arg_count)));
1da177e4 LT	89	}
1da177e4 LT	90
1da177e4 LT	91	/*******************************************************************************
	92	*
	93	* FUNCTION: acpi_ps_init_scope
	94	*
	95	* PARAMETERS: parser_state - Current parser state object
ba494bee	96	* root - the Root Node of this new scope
1da177e4 LT	97	*
	98	* RETURN: Status
	99	*
	100	* DESCRIPTION: Allocate and init a new scope object
	101	*
	102	******************************************************************************/
	103
	104	acpi_status
4be44fcd LB	105	acpi_ps_init_scope(struct acpi_parse_state * parser_state,
4be44fcd LB	106	union acpi_parse_object * root_op)
1da177e4	107	{
4be44fcd	108	union acpi_generic_state *scope;
1da177e4	109
b229cf92	110	ACPI_FUNCTION_TRACE_PTR(ps_init_scope, root_op);
1da177e4	111
4be44fcd	112	scope = acpi_ut_create_generic_state();
1da177e4	113	if (!scope) {
4be44fcd	114	return_ACPI_STATUS(AE_NO_MEMORY);
1da177e4 LT	115	}
1da177e4 LT	116
61686124	117	scope->common.descriptor_type = ACPI_DESC_TYPE_STATE_RPSCOPE;
4be44fcd	118	scope->parse_scope.op = root_op;
1da177e4	119	scope->parse_scope.arg_count = ACPI_VAR_ARGS;
4be44fcd LB	120	scope->parse_scope.arg_end = parser_state->aml_end;
4be44fcd LB	121	scope->parse_scope.pkg_end = parser_state->aml_end;
1da177e4	122
4be44fcd LB	123	parser_state->scope = scope;
4be44fcd LB	124	parser_state->start_op = root_op;
1da177e4	125
4be44fcd	126	return_ACPI_STATUS(AE_OK);
1da177e4 LT	127	}
1da177e4 LT	128
1da177e4 LT	129	/*******************************************************************************
	130	*
	131	* FUNCTION: acpi_ps_push_scope
	132	*
	133	* PARAMETERS: parser_state - Current parser state object
ba494bee	134	* op - Current op to be pushed
1da177e4 LT	135	* remaining_args - List of args remaining
	136	* arg_count - Fixed or variable number of args
	137	*
	138	* RETURN: Status
	139	*
	140	* DESCRIPTION: Push current op to begin parsing its argument
	141	*
	142	******************************************************************************/
	143
	144	acpi_status
4be44fcd LB	145	acpi_ps_push_scope(struct acpi_parse_state *parser_state,
4be44fcd LB	146	union acpi_parse_object *op,
793c2388	147	u32 remaining_args, u32 arg_count)
1da177e4	148	{
4be44fcd	149	union acpi_generic_state *scope;
1da177e4	150
b229cf92	151	ACPI_FUNCTION_TRACE_PTR(ps_push_scope, op);
1da177e4	152
4be44fcd	153	scope = acpi_ut_create_generic_state();
1da177e4	154	if (!scope) {
4be44fcd	155	return_ACPI_STATUS(AE_NO_MEMORY);
1da177e4 LT	156	}
1da177e4 LT	157
61686124	158	scope->common.descriptor_type = ACPI_DESC_TYPE_STATE_PSCOPE;
4be44fcd	159	scope->parse_scope.op = op;
44f6c012 RM	160	scope->parse_scope.arg_list = remaining_args;
	161	scope->parse_scope.arg_count = arg_count;
	162	scope->parse_scope.pkg_end = parser_state->pkg_end;
1da177e4 LT	163
	164	/* Push onto scope stack */
	165
4be44fcd	166	acpi_ut_push_generic_state(&parser_state->scope, scope);
1da177e4 LT	167
1da177e4 LT	168	if (arg_count == ACPI_VAR_ARGS) {
52fc0b02	169
44f6c012	170	/* Multiple arguments */
1da177e4 LT	171
1da177e4 LT	172	scope->parse_scope.arg_end = parser_state->pkg_end;
4be44fcd	173	} else {
44f6c012	174	/* Single argument */
1da177e4	175
4be44fcd	176	scope->parse_scope.arg_end = ACPI_TO_POINTER(ACPI_MAX_PTR);
1da177e4 LT	177	}
1da177e4 LT	178
4be44fcd	179	return_ACPI_STATUS(AE_OK);
1da177e4 LT	180	}
1da177e4 LT	181
1da177e4 LT	182	/*******************************************************************************
	183	*
	184	* FUNCTION: acpi_ps_pop_scope
	185	*
	186	* PARAMETERS: parser_state - Current parser state object
ba494bee	187	* op - Where the popped op is returned
1da177e4 LT	188	* arg_list - Where the popped "next argument" is
	189	* returned
	190	* arg_count - Count of objects in arg_list
	191	*
	192	* RETURN: Status
	193	*
	194	* DESCRIPTION: Return to parsing a previous op
	195	*
	196	******************************************************************************/
	197
	198	void
4be44fcd	199	acpi_ps_pop_scope(struct acpi_parse_state *parser_state,
793c2388	200	union acpi_parse_object *op, u32 arg_list, u32 * arg_count)
1da177e4	201	{
4be44fcd	202	union acpi_generic_state *scope = parser_state->scope;
1da177e4	203
b229cf92	204	ACPI_FUNCTION_TRACE(ps_pop_scope);
1da177e4	205
44f6c012 RM	206	/* Only pop the scope if there is in fact a next scope */
44f6c012 RM	207
1da177e4	208	if (scope->common.next) {
4be44fcd	209	scope = acpi_ut_pop_generic_state(&parser_state->scope);
1da177e4	210
61686124	211	/* Return to parsing previous op */
1da177e4	212
4be44fcd LB	213	*op = scope->parse_scope.op;
	214	*arg_list = scope->parse_scope.arg_list;
	215	*arg_count = scope->parse_scope.arg_count;
44f6c012	216	parser_state->pkg_end = scope->parse_scope.pkg_end;
1da177e4 LT	217
	218	/* All done with this scope state structure */
	219
4be44fcd LB	220	acpi_ut_delete_generic_state(scope);
4be44fcd LB	221	} else {
61686124	222	/* Empty parse stack, prepare to fetch next opcode */
1da177e4	223
4be44fcd	224	*op = NULL;
44f6c012 RM	225	*arg_list = 0;
44f6c012 RM	226	*arg_count = 0;
1da177e4 LT	227	}
1da177e4 LT	228
4be44fcd LB	229	ACPI_DEBUG_PRINT((ACPI_DB_PARSE,
4be44fcd LB	230	"Popped Op %p Args %X\n", op, arg_count));
1da177e4 LT	231	return_VOID;
	232	}
	233
1da177e4 LT	234	/*******************************************************************************
	235	*
	236	* FUNCTION: acpi_ps_cleanup_scope
	237	*
	238	* PARAMETERS: parser_state - Current parser state object
	239	*
44f6c012	240	* RETURN: None
1da177e4 LT	241	*
	242	* DESCRIPTION: Destroy available list, remaining stack levels, and return
	243	* root scope
	244	*
	245	******************************************************************************/
	246
4be44fcd	247	void acpi_ps_cleanup_scope(struct acpi_parse_state *parser_state)
1da177e4	248	{
4be44fcd	249	union acpi_generic_state *scope;
1da177e4	250
b229cf92	251	ACPI_FUNCTION_TRACE_PTR(ps_cleanup_scope, parser_state);
1da177e4 LT	252
	253	if (!parser_state) {
	254	return_VOID;
	255	}
	256
	257	/* Delete anything on the scope stack */
	258
	259	while (parser_state->scope) {
4be44fcd LB	260	scope = acpi_ut_pop_generic_state(&parser_state->scope);
4be44fcd LB	261	acpi_ut_delete_generic_state(scope);
1da177e4 LT	262	}
	263
	264	return_VOID;
	265	}