[linux-2.6-block.git] / drivers / acpi / acpica / acinterp.h

/******************************************************************************
 *
 * Name: acinterp.h - Interpreter subcomponent prototypes and defines
 *
 *****************************************************************************/

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

#ifndef __ACINTERP_H__
#define __ACINTERP_H__

#define ACPI_WALK_OPERANDS          (&(walk_state->operands [walk_state->num_operands -1]))

/* Macros for tables used for debug output */

#define ACPI_EXD_OFFSET(f)          (u8) ACPI_OFFSET (union acpi_operand_object,f)
#define ACPI_EXD_NSOFFSET(f)        (u8) ACPI_OFFSET (struct acpi_namespace_node,f)
#define ACPI_EXD_TABLE_SIZE(name)   (sizeof(name) / sizeof (struct acpi_exdump_info))

/*
 * If possible, pack the following structures to byte alignment, since we
 * don't care about performance for debug output. Two cases where we cannot
 * pack the structures:
 *
 * 1) Hardware does not support misaligned memory transfers
 * 2) Compiler does not support pointers within packed structures
 */
#if (!defined(ACPI_MISALIGNMENT_NOT_SUPPORTED) && !defined(ACPI_PACKED_POINTERS_NOT_SUPPORTED))
#pragma pack(1)
#endif

typedef const struct acpi_exdump_info {
	u8 opcode;
	u8 offset;
	char *name;

} acpi_exdump_info;

/* Values for the Opcode field above */

#define ACPI_EXD_INIT                   0
#define ACPI_EXD_TYPE                   1
#define ACPI_EXD_UINT8                  2
#define ACPI_EXD_UINT16                 3
#define ACPI_EXD_UINT32                 4
#define ACPI_EXD_UINT64                 5
#define ACPI_EXD_LITERAL                6
#define ACPI_EXD_POINTER                7
#define ACPI_EXD_ADDRESS                8
#define ACPI_EXD_STRING                 9
#define ACPI_EXD_BUFFER                 10
#define ACPI_EXD_PACKAGE                11
#define ACPI_EXD_FIELD                  12
#define ACPI_EXD_REFERENCE              13
#define ACPI_EXD_LIST                   14	/* Operand object list */
#define ACPI_EXD_HDLR_LIST              15	/* Address Handler list */
#define ACPI_EXD_RGN_LIST               16	/* Region list */
#define ACPI_EXD_NODE                   17	/* Namespace Node */

/* restore default alignment */

#pragma pack()

/*
 * exconvrt - object conversion
 */
acpi_status
acpi_ex_convert_to_integer(union acpi_operand_object *obj_desc,
			   union acpi_operand_object **result_desc, u32 flags);

acpi_status
acpi_ex_convert_to_buffer(union acpi_operand_object *obj_desc,
			  union acpi_operand_object **result_desc);

acpi_status
acpi_ex_convert_to_string(union acpi_operand_object *obj_desc,
			  union acpi_operand_object **result_desc, u32 type);

/* Types for ->String conversion */

#define ACPI_EXPLICIT_BYTE_COPY         0x00000000
#define ACPI_EXPLICIT_CONVERT_HEX       0x00000001
#define ACPI_IMPLICIT_CONVERT_HEX       0x00000002
#define ACPI_EXPLICIT_CONVERT_DECIMAL   0x00000003

acpi_status
acpi_ex_convert_to_target_type(acpi_object_type destination_type,
			       union acpi_operand_object *source_desc,
			       union acpi_operand_object **result_desc,
			       struct acpi_walk_state *walk_state);

/*
 * exdebug - AML debug object
 */
void
acpi_ex_do_debug_object(union acpi_operand_object *source_desc,
			u32 level, u32 index);

/*
 * exfield - ACPI AML (p-code) execution - field manipulation
 */
acpi_status
acpi_ex_common_buffer_setup(union acpi_operand_object *obj_desc,
			    u32 buffer_length, u32 * datum_count);

acpi_status
acpi_ex_write_with_update_rule(union acpi_operand_object *obj_desc,
			       u64 mask,
			       u64 field_value, u32 field_datum_byte_offset);

void
acpi_ex_get_buffer_datum(u64 *datum,
			 void *buffer,
			 u32 buffer_length,
			 u32 byte_granularity, u32 buffer_offset);

void
acpi_ex_set_buffer_datum(u64 merged_datum,
			 void *buffer,
			 u32 buffer_length,
			 u32 byte_granularity, u32 buffer_offset);

acpi_status
acpi_ex_read_data_from_field(struct acpi_walk_state *walk_state,
			     union acpi_operand_object *obj_desc,
			     union acpi_operand_object **ret_buffer_desc);

acpi_status
acpi_ex_write_data_to_field(union acpi_operand_object *source_desc,
			    union acpi_operand_object *obj_desc,
			    union acpi_operand_object **result_desc);

/*
 * exfldio - low level field I/O
 */
acpi_status
acpi_ex_extract_from_field(union acpi_operand_object *obj_desc,
			   void *buffer, u32 buffer_length);

acpi_status
acpi_ex_insert_into_field(union acpi_operand_object *obj_desc,
			  void *buffer, u32 buffer_length);

acpi_status
acpi_ex_access_region(union acpi_operand_object *obj_desc,
		      u32 field_datum_byte_offset, u64 *value, u32 read_write);

/*
 * exmisc - misc support routines
 */
acpi_status
acpi_ex_get_object_reference(union acpi_operand_object *obj_desc,
			     union acpi_operand_object **return_desc,
			     struct acpi_walk_state *walk_state);

acpi_status
acpi_ex_concat_template(union acpi_operand_object *obj_desc,
			union acpi_operand_object *obj_desc2,
			union acpi_operand_object **actual_return_desc,
			struct acpi_walk_state *walk_state);

acpi_status
acpi_ex_do_concatenate(union acpi_operand_object *obj_desc,
		       union acpi_operand_object *obj_desc2,
		       union acpi_operand_object **actual_return_desc,
		       struct acpi_walk_state *walk_state);

acpi_status
acpi_ex_do_logical_numeric_op(u16 opcode,
			      u64 integer0, u64 integer1, u8 *logical_result);

acpi_status
acpi_ex_do_logical_op(u16 opcode,
		      union acpi_operand_object *operand0,
		      union acpi_operand_object *operand1, u8 *logical_result);

u64 acpi_ex_do_math_op(u16 opcode, u64 operand0, u64 operand1);

acpi_status acpi_ex_create_mutex(struct acpi_walk_state *walk_state);

acpi_status acpi_ex_create_processor(struct acpi_walk_state *walk_state);

acpi_status acpi_ex_create_power_resource(struct acpi_walk_state *walk_state);

acpi_status
acpi_ex_create_region(u8 * aml_start,
		      u32 aml_length,
		      u8 region_space, struct acpi_walk_state *walk_state);

acpi_status acpi_ex_create_event(struct acpi_walk_state *walk_state);

acpi_status acpi_ex_create_alias(struct acpi_walk_state *walk_state);

acpi_status
acpi_ex_create_method(u8 * aml_start,
		      u32 aml_length, struct acpi_walk_state *walk_state);

/*
 * exconfig - dynamic table load/unload
 */
acpi_status
acpi_ex_load_op(union acpi_operand_object *obj_desc,
		union acpi_operand_object *target,
		struct acpi_walk_state *walk_state);

acpi_status
acpi_ex_load_table_op(struct acpi_walk_state *walk_state,
		      union acpi_operand_object **return_desc);

acpi_status acpi_ex_unload_table(union acpi_operand_object *ddb_handle);

/*
 * exmutex - mutex support
 */
acpi_status
acpi_ex_acquire_mutex(union acpi_operand_object *time_desc,
		      union acpi_operand_object *obj_desc,
		      struct acpi_walk_state *walk_state);

acpi_status
acpi_ex_acquire_mutex_object(u16 timeout,
			     union acpi_operand_object *obj_desc,
			     acpi_thread_id thread_id);

acpi_status
acpi_ex_release_mutex(union acpi_operand_object *obj_desc,
		      struct acpi_walk_state *walk_state);

acpi_status acpi_ex_release_mutex_object(union acpi_operand_object *obj_desc);

void acpi_ex_release_all_mutexes(struct acpi_thread_state *thread);

void acpi_ex_unlink_mutex(union acpi_operand_object *obj_desc);

/*
 * exprep - ACPI AML execution - prep utilities
 */
acpi_status
acpi_ex_prep_common_field_object(union acpi_operand_object *obj_desc,
				 u8 field_flags,
				 u8 field_attribute,
				 u32 field_bit_position, u32 field_bit_length);

acpi_status acpi_ex_prep_field_value(struct acpi_create_field_info *info);

/*
 * exsystem - Interface to OS services
 */
acpi_status
acpi_ex_system_do_notify_op(union acpi_operand_object *value,
			    union acpi_operand_object *obj_desc);

acpi_status acpi_ex_system_do_sleep(u64 time);

acpi_status acpi_ex_system_do_stall(u32 time);

acpi_status acpi_ex_system_signal_event(union acpi_operand_object *obj_desc);

acpi_status
acpi_ex_system_wait_event(union acpi_operand_object *time,
			  union acpi_operand_object *obj_desc);

acpi_status acpi_ex_system_reset_event(union acpi_operand_object *obj_desc);

acpi_status
acpi_ex_system_wait_semaphore(acpi_semaphore semaphore, u16 timeout);

acpi_status acpi_ex_system_wait_mutex(acpi_mutex mutex, u16 timeout);

/*
 * exoparg1 - ACPI AML execution, 1 operand
 */
acpi_status acpi_ex_opcode_0A_0T_1R(struct acpi_walk_state *walk_state);

acpi_status acpi_ex_opcode_1A_0T_0R(struct acpi_walk_state *walk_state);

acpi_status acpi_ex_opcode_1A_0T_1R(struct acpi_walk_state *walk_state);

acpi_status acpi_ex_opcode_1A_1T_1R(struct acpi_walk_state *walk_state);

acpi_status acpi_ex_opcode_1A_1T_0R(struct acpi_walk_state *walk_state);

/*
 * exoparg2 - ACPI AML execution, 2 operands
 */
acpi_status acpi_ex_opcode_2A_0T_0R(struct acpi_walk_state *walk_state);

acpi_status acpi_ex_opcode_2A_0T_1R(struct acpi_walk_state *walk_state);

acpi_status acpi_ex_opcode_2A_1T_1R(struct acpi_walk_state *walk_state);

acpi_status acpi_ex_opcode_2A_2T_1R(struct acpi_walk_state *walk_state);

/*
 * exoparg3 - ACPI AML execution, 3 operands
 */
acpi_status acpi_ex_opcode_3A_0T_0R(struct acpi_walk_state *walk_state);

acpi_status acpi_ex_opcode_3A_1T_1R(struct acpi_walk_state *walk_state);

/*
 * exoparg6 - ACPI AML execution, 6 operands
 */
acpi_status acpi_ex_opcode_6A_0T_1R(struct acpi_walk_state *walk_state);

/*
 * exresolv - Object resolution and get value functions
 */
acpi_status
acpi_ex_resolve_to_value(union acpi_operand_object **stack_ptr,
			 struct acpi_walk_state *walk_state);

acpi_status
acpi_ex_resolve_multiple(struct acpi_walk_state *walk_state,
			 union acpi_operand_object *operand,
			 acpi_object_type * return_type,
			 union acpi_operand_object **return_desc);

/*
 * exresnte - resolve namespace node
 */
acpi_status
acpi_ex_resolve_node_to_value(struct acpi_namespace_node **stack_ptr,
			      struct acpi_walk_state *walk_state);

/*
 * exresop - resolve operand to value
 */
acpi_status
acpi_ex_resolve_operands(u16 opcode,
			 union acpi_operand_object **stack_ptr,
			 struct acpi_walk_state *walk_state);

/*
 * exdump - Interpreter debug output routines
 */
void acpi_ex_dump_operand(union acpi_operand_object *obj_desc, u32 depth);

void
acpi_ex_dump_operands(union acpi_operand_object **operands,
		      const char *opcode_name, u32 num_opcodes);

#ifdef	ACPI_FUTURE_USAGE
void
acpi_ex_dump_object_descriptor(union acpi_operand_object *object, u32 flags);

void acpi_ex_dump_namespace_node(struct acpi_namespace_node *node, u32 flags);
#endif				/* ACPI_FUTURE_USAGE */

/*
 * exnames - AML namestring support
 */
acpi_status
acpi_ex_get_name_string(acpi_object_type data_type,
			u8 * in_aml_address,
			char **out_name_string, u32 * out_name_length);

/*
 * exstore - Object store support
 */
acpi_status
acpi_ex_store(union acpi_operand_object *val_desc,
	      union acpi_operand_object *dest_desc,
	      struct acpi_walk_state *walk_state);

acpi_status
acpi_ex_store_object_to_node(union acpi_operand_object *source_desc,
			     struct acpi_namespace_node *node,
			     struct acpi_walk_state *walk_state,
			     u8 implicit_conversion);

#define ACPI_IMPLICIT_CONVERSION        TRUE
#define ACPI_NO_IMPLICIT_CONVERSION     FALSE

/*
 * exstoren - resolve/store object
 */
acpi_status
acpi_ex_resolve_object(union acpi_operand_object **source_desc_ptr,
		       acpi_object_type target_type,
		       struct acpi_walk_state *walk_state);

acpi_status
acpi_ex_store_object_to_object(union acpi_operand_object *source_desc,
			       union acpi_operand_object *dest_desc,
			       union acpi_operand_object **new_desc,
			       struct acpi_walk_state *walk_state);

/*
 * exstorob - store object - buffer/string
 */
acpi_status
acpi_ex_store_buffer_to_buffer(union acpi_operand_object *source_desc,
			       union acpi_operand_object *target_desc);

acpi_status
acpi_ex_store_string_to_string(union acpi_operand_object *source_desc,
			       union acpi_operand_object *target_desc);

/*
 * excopy - object copy
 */
acpi_status
acpi_ex_copy_integer_to_index_field(union acpi_operand_object *source_desc,
				    union acpi_operand_object *target_desc);

acpi_status
acpi_ex_copy_integer_to_bank_field(union acpi_operand_object *source_desc,
				   union acpi_operand_object *target_desc);

acpi_status
acpi_ex_copy_data_to_named_field(union acpi_operand_object *source_desc,
				 struct acpi_namespace_node *node);

acpi_status
acpi_ex_copy_integer_to_buffer_field(union acpi_operand_object *source_desc,
				     union acpi_operand_object *target_desc);

/*
 * exutils - interpreter/scanner utilities
 */
void acpi_ex_enter_interpreter(void);

void acpi_ex_exit_interpreter(void);

u8 acpi_ex_truncate_for32bit_table(union acpi_operand_object *obj_desc);

void acpi_ex_acquire_global_lock(u32 rule);

void acpi_ex_release_global_lock(u32 rule);

void acpi_ex_eisa_id_to_string(char *dest, u64 compressed_id);

void acpi_ex_integer_to_string(char *dest, u64 value);

void acpi_ex_pci_cls_to_string(char *dest, u8 class_code[3]);

u8 acpi_is_valid_space_id(u8 space_id);

/*
 * exregion - default op_region handlers
 */
acpi_status
acpi_ex_system_memory_space_handler(u32 function,
				    acpi_physical_address address,
				    u32 bit_width,
				    u64 *value,
				    void *handler_context,
				    void *region_context);

acpi_status
acpi_ex_system_io_space_handler(u32 function,
				acpi_physical_address address,
				u32 bit_width,
				u64 *value,
				void *handler_context, void *region_context);

acpi_status
acpi_ex_pci_config_space_handler(u32 function,
				 acpi_physical_address address,
				 u32 bit_width,
				 u64 *value,
				 void *handler_context, void *region_context);

acpi_status
acpi_ex_cmos_space_handler(u32 function,
			   acpi_physical_address address,
			   u32 bit_width,
			   u64 *value,
			   void *handler_context, void *region_context);

acpi_status
acpi_ex_pci_bar_space_handler(u32 function,
			      acpi_physical_address address,
			      u32 bit_width,
			      u64 *value,
			      void *handler_context, void *region_context);

acpi_status
acpi_ex_embedded_controller_space_handler(u32 function,
					  acpi_physical_address address,
					  u32 bit_width,
					  u64 *value,
					  void *handler_context,
					  void *region_context);

acpi_status
acpi_ex_sm_bus_space_handler(u32 function,
			     acpi_physical_address address,
			     u32 bit_width,
			     u64 *value,
			     void *handler_context, void *region_context);

acpi_status
acpi_ex_data_table_space_handler(u32 function,
				 acpi_physical_address address,
				 u32 bit_width,
				 u64 *value,
				 void *handler_context, void *region_context);

#endif				/* __INTERP_H__ */
Commit	Line	Data
1da177e4 LT	1	/******************************************************************************
	2	*
	3	* Name: acinterp.h - Interpreter subcomponent prototypes and defines
	4	*
	5	*****************************************************************************/
	6
	7	/*
82a80941	8	* Copyright (C) 2000 - 2015, 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
	44	#ifndef __ACINTERP_H__
	45	#define __ACINTERP_H__
	46
96db255c BM	47	#define ACPI_WALK_OPERANDS (&(walk_state->operands [walk_state->num_operands -1]))
	48
	49	/* Macros for tables used for debug output */
	50
	51	#define ACPI_EXD_OFFSET(f) (u8) ACPI_OFFSET (union acpi_operand_object,f)
	52	#define ACPI_EXD_NSOFFSET(f) (u8) ACPI_OFFSET (struct acpi_namespace_node,f)
	53	#define ACPI_EXD_TABLE_SIZE(name) (sizeof(name) / sizeof (struct acpi_exdump_info))
	54
	55	/*
f6dd9221 BM	56	* If possible, pack the following structures to byte alignment, since we
	57	* don't care about performance for debug output. Two cases where we cannot
	58	* pack the structures:
	59	*
	60	* 1) Hardware does not support misaligned memory transfers
	61	* 2) Compiler does not support pointers within packed structures
96db255c	62	*/
f6dd9221	63	#if (!defined(ACPI_MISALIGNMENT_NOT_SUPPORTED) && !defined(ACPI_PACKED_POINTERS_NOT_SUPPORTED))
96db255c BM	64	#pragma pack(1)
	65	#endif
	66
	67	typedef const struct acpi_exdump_info {
	68	u8 opcode;
	69	u8 offset;
	70	char *name;
	71
	72	} acpi_exdump_info;
	73
	74	/* Values for the Opcode field above */
	75
	76	#define ACPI_EXD_INIT 0
	77	#define ACPI_EXD_TYPE 1
	78	#define ACPI_EXD_UINT8 2
	79	#define ACPI_EXD_UINT16 3
	80	#define ACPI_EXD_UINT32 4
	81	#define ACPI_EXD_UINT64 5
	82	#define ACPI_EXD_LITERAL 6
	83	#define ACPI_EXD_POINTER 7
	84	#define ACPI_EXD_ADDRESS 8
	85	#define ACPI_EXD_STRING 9
	86	#define ACPI_EXD_BUFFER 10
	87	#define ACPI_EXD_PACKAGE 11
	88	#define ACPI_EXD_FIELD 12
	89	#define ACPI_EXD_REFERENCE 13
a487af33 BM	90	#define ACPI_EXD_LIST 14 /* Operand object list */
	91	#define ACPI_EXD_HDLR_LIST 15 /* Address Handler list */
	92	#define ACPI_EXD_RGN_LIST 16 /* Region list */
	93	#define ACPI_EXD_NODE 17 /* Namespace Node */
96db255c BM	94
	95	/* restore default alignment */
	96
	97	#pragma pack()
1da177e4	98
1da177e4 LT	99	/*
	100	* exconvrt - object conversion
	101	*/
1da177e4	102	acpi_status
4be44fcd LB	103	acpi_ex_convert_to_integer(union acpi_operand_object *obj_desc,
4be44fcd LB	104	union acpi_operand_object **result_desc, u32 flags);
1da177e4 LT	105
1da177e4 LT	106	acpi_status
4be44fcd LB	107	acpi_ex_convert_to_buffer(union acpi_operand_object *obj_desc,
4be44fcd LB	108	union acpi_operand_object **result_desc);
1da177e4 LT	109
1da177e4 LT	110	acpi_status
4be44fcd LB	111	acpi_ex_convert_to_string(union acpi_operand_object *obj_desc,
4be44fcd LB	112	union acpi_operand_object **result_desc, u32 type);
1da177e4 LT	113
	114	/* Types for ->String conversion */
	115
	116	#define ACPI_EXPLICIT_BYTE_COPY 0x00000000
	117	#define ACPI_EXPLICIT_CONVERT_HEX 0x00000001
	118	#define ACPI_IMPLICIT_CONVERT_HEX 0x00000002
	119	#define ACPI_EXPLICIT_CONVERT_DECIMAL 0x00000003
	120
	121	acpi_status
4be44fcd LB	122	acpi_ex_convert_to_target_type(acpi_object_type destination_type,
	123	union acpi_operand_object *source_desc,
	124	union acpi_operand_object **result_desc,
	125	struct acpi_walk_state *walk_state);
1da177e4	126
4cdf1a56 LM	127	/*
	128	* exdebug - AML debug object
	129	*/
	130	void
	131	acpi_ex_do_debug_object(union acpi_operand_object *source_desc,
	132	u32 level, u32 index);
	133
1da177e4 LT	134	/*
	135	* exfield - ACPI AML (p-code) execution - field manipulation
	136	*/
1da177e4	137	acpi_status
4be44fcd LB	138	acpi_ex_common_buffer_setup(union acpi_operand_object *obj_desc,
4be44fcd LB	139	u32 buffer_length, u32 * datum_count);
1da177e4	140
1da177e4	141	acpi_status
4be44fcd	142	acpi_ex_write_with_update_rule(union acpi_operand_object *obj_desc,
5df7e6cb BM	143	u64 mask,
5df7e6cb BM	144	u64 field_value, u32 field_datum_byte_offset);
1da177e4 LT	145
1da177e4 LT	146	void
5df7e6cb	147	acpi_ex_get_buffer_datum(u64 *datum,
4be44fcd LB	148	void *buffer,
	149	u32 buffer_length,
	150	u32 byte_granularity, u32 buffer_offset);
1da177e4 LT	151
1da177e4 LT	152	void
5df7e6cb	153	acpi_ex_set_buffer_datum(u64 merged_datum,
4be44fcd LB	154	void *buffer,
	155	u32 buffer_length,
	156	u32 byte_granularity, u32 buffer_offset);
1da177e4 LT	157
1da177e4 LT	158	acpi_status
4be44fcd LB	159	acpi_ex_read_data_from_field(struct acpi_walk_state *walk_state,
	160	union acpi_operand_object *obj_desc,
	161	union acpi_operand_object **ret_buffer_desc);
1da177e4 LT	162
1da177e4 LT	163	acpi_status
4be44fcd LB	164	acpi_ex_write_data_to_field(union acpi_operand_object *source_desc,
	165	union acpi_operand_object *obj_desc,
	166	union acpi_operand_object **result_desc);
44f6c012	167
1da177e4	168	/*
44f6c012	169	* exfldio - low level field I/O
1da177e4	170	*/
1da177e4	171	acpi_status
4be44fcd LB	172	acpi_ex_extract_from_field(union acpi_operand_object *obj_desc,
4be44fcd LB	173	void *buffer, u32 buffer_length);
1da177e4 LT	174
1da177e4 LT	175	acpi_status
4be44fcd LB	176	acpi_ex_insert_into_field(union acpi_operand_object *obj_desc,
4be44fcd LB	177	void *buffer, u32 buffer_length);
1da177e4 LT	178
1da177e4 LT	179	acpi_status
4be44fcd	180	acpi_ex_access_region(union acpi_operand_object *obj_desc,
5df7e6cb	181	u32 field_datum_byte_offset, u64 *value, u32 read_write);
1da177e4	182
44f6c012 RM	183	/*
	184	* exmisc - misc support routines
	185	*/
1da177e4	186	acpi_status
4be44fcd LB	187	acpi_ex_get_object_reference(union acpi_operand_object *obj_desc,
	188	union acpi_operand_object **return_desc,
	189	struct acpi_walk_state *walk_state);
1da177e4	190
1da177e4	191	acpi_status
4be44fcd LB	192	acpi_ex_concat_template(union acpi_operand_object *obj_desc,
	193	union acpi_operand_object *obj_desc2,
	194	union acpi_operand_object **actual_return_desc,
	195	struct acpi_walk_state *walk_state);
1da177e4 LT	196
1da177e4 LT	197	acpi_status
4be44fcd LB	198	acpi_ex_do_concatenate(union acpi_operand_object *obj_desc,
	199	union acpi_operand_object *obj_desc2,
	200	union acpi_operand_object **actual_return_desc,
	201	struct acpi_walk_state *walk_state);
1da177e4 LT	202
1da177e4 LT	203	acpi_status
4be44fcd	204	acpi_ex_do_logical_numeric_op(u16 opcode,
5df7e6cb	205	u64 integer0, u64 integer1, u8 *logical_result);
1da177e4 LT	206
1da177e4 LT	207	acpi_status
4be44fcd LB	208	acpi_ex_do_logical_op(u16 opcode,
4be44fcd LB	209	union acpi_operand_object *operand0,
5df7e6cb	210	union acpi_operand_object operand1, u8 logical_result);
1da177e4	211
5df7e6cb	212	u64 acpi_ex_do_math_op(u16 opcode, u64 operand0, u64 operand1);
1da177e4	213
4be44fcd	214	acpi_status acpi_ex_create_mutex(struct acpi_walk_state *walk_state);
1da177e4	215
4be44fcd	216	acpi_status acpi_ex_create_processor(struct acpi_walk_state *walk_state);
1da177e4	217
4be44fcd	218	acpi_status acpi_ex_create_power_resource(struct acpi_walk_state *walk_state);
1da177e4 LT	219
1da177e4 LT	220	acpi_status
4be44fcd LB	221	acpi_ex_create_region(u8 * aml_start,
	222	u32 aml_length,
	223	u8 region_space, struct acpi_walk_state *walk_state);
1da177e4	224
4be44fcd	225	acpi_status acpi_ex_create_event(struct acpi_walk_state *walk_state);
1da177e4	226
4be44fcd	227	acpi_status acpi_ex_create_alias(struct acpi_walk_state *walk_state);
1da177e4 LT	228
1da177e4 LT	229	acpi_status
4be44fcd LB	230	acpi_ex_create_method(u8 * aml_start,
4be44fcd LB	231	u32 aml_length, struct acpi_walk_state *walk_state);
1da177e4 LT	232
	233	/*
	234	* exconfig - dynamic table load/unload
	235	*/
1da177e4	236	acpi_status
4be44fcd LB	237	acpi_ex_load_op(union acpi_operand_object *obj_desc,
	238	union acpi_operand_object *target,
	239	struct acpi_walk_state *walk_state);
1da177e4 LT	240
1da177e4 LT	241	acpi_status
4be44fcd LB	242	acpi_ex_load_table_op(struct acpi_walk_state *walk_state,
4be44fcd LB	243	union acpi_operand_object **return_desc);
1da177e4	244
4be44fcd	245	acpi_status acpi_ex_unload_table(union acpi_operand_object *ddb_handle);
1da177e4 LT	246
	247	/*
	248	* exmutex - mutex support
	249	*/
1da177e4	250	acpi_status
4be44fcd LB	251	acpi_ex_acquire_mutex(union acpi_operand_object *time_desc,
	252	union acpi_operand_object *obj_desc,
	253	struct acpi_walk_state *walk_state);
1da177e4	254
ba886cd4 BM	255	acpi_status
	256	acpi_ex_acquire_mutex_object(u16 timeout,
	257	union acpi_operand_object *obj_desc,
	258	acpi_thread_id thread_id);
	259
1da177e4	260	acpi_status
4be44fcd LB	261	acpi_ex_release_mutex(union acpi_operand_object *obj_desc,
4be44fcd LB	262	struct acpi_walk_state *walk_state);
1da177e4	263
ba886cd4 BM	264	acpi_status acpi_ex_release_mutex_object(union acpi_operand_object *obj_desc);
ba886cd4 BM	265
4be44fcd	266	void acpi_ex_release_all_mutexes(struct acpi_thread_state *thread);
1da177e4	267
262a7a28	268	void acpi_ex_unlink_mutex(union acpi_operand_object *obj_desc);
1da177e4 LT	269
1da177e4 LT	270	/*
44f6c012	271	* exprep - ACPI AML execution - prep utilities
1da177e4	272	*/
1da177e4	273	acpi_status
4be44fcd LB	274	acpi_ex_prep_common_field_object(union acpi_operand_object *obj_desc,
	275	u8 field_flags,
	276	u8 field_attribute,
	277	u32 field_bit_position, u32 field_bit_length);
1da177e4	278
4be44fcd	279	acpi_status acpi_ex_prep_field_value(struct acpi_create_field_info *info);
44f6c012	280
1da177e4 LT	281	/*
	282	* exsystem - Interface to OS services
	283	*/
1da177e4	284	acpi_status
4be44fcd LB	285	acpi_ex_system_do_notify_op(union acpi_operand_object *value,
4be44fcd LB	286	union acpi_operand_object *obj_desc);
1da177e4	287
ada241dc	288	acpi_status acpi_ex_system_do_sleep(u64 time);
1da177e4	289
4be44fcd	290	acpi_status acpi_ex_system_do_stall(u32 time);
1da177e4	291
4be44fcd	292	acpi_status acpi_ex_system_signal_event(union acpi_operand_object *obj_desc);
1da177e4 LT	293
1da177e4 LT	294	acpi_status
4be44fcd LB	295	acpi_ex_system_wait_event(union acpi_operand_object *time,
4be44fcd LB	296	union acpi_operand_object *obj_desc);
1da177e4	297
4be44fcd	298	acpi_status acpi_ex_system_reset_event(union acpi_operand_object *obj_desc);
1da177e4	299
967440e3 BM	300	acpi_status
	301	acpi_ex_system_wait_semaphore(acpi_semaphore semaphore, u16 timeout);
	302
	303	acpi_status acpi_ex_system_wait_mutex(acpi_mutex mutex, u16 timeout);
1da177e4 LT	304
1da177e4 LT	305	/*
44f6c012	306	* exoparg1 - ACPI AML execution, 1 operand
1da177e4	307	*/
4be44fcd	308	acpi_status acpi_ex_opcode_0A_0T_1R(struct acpi_walk_state *walk_state);
1da177e4	309
4be44fcd	310	acpi_status acpi_ex_opcode_1A_0T_0R(struct acpi_walk_state *walk_state);
1da177e4	311
4be44fcd	312	acpi_status acpi_ex_opcode_1A_0T_1R(struct acpi_walk_state *walk_state);
1da177e4	313
4be44fcd	314	acpi_status acpi_ex_opcode_1A_1T_1R(struct acpi_walk_state *walk_state);
1da177e4	315
4be44fcd	316	acpi_status acpi_ex_opcode_1A_1T_0R(struct acpi_walk_state *walk_state);
1da177e4 LT	317
1da177e4 LT	318	/*
44f6c012	319	* exoparg2 - ACPI AML execution, 2 operands
1da177e4	320	*/
4be44fcd	321	acpi_status acpi_ex_opcode_2A_0T_0R(struct acpi_walk_state *walk_state);
1da177e4	322
4be44fcd	323	acpi_status acpi_ex_opcode_2A_0T_1R(struct acpi_walk_state *walk_state);
1da177e4	324
4be44fcd	325	acpi_status acpi_ex_opcode_2A_1T_1R(struct acpi_walk_state *walk_state);
1da177e4	326
4be44fcd	327	acpi_status acpi_ex_opcode_2A_2T_1R(struct acpi_walk_state *walk_state);
1da177e4 LT	328
1da177e4 LT	329	/*
44f6c012 RM	330	* exoparg3 - ACPI AML execution, 3 operands
44f6c012 RM	331	*/
4be44fcd	332	acpi_status acpi_ex_opcode_3A_0T_0R(struct acpi_walk_state *walk_state);
44f6c012	333
4be44fcd	334	acpi_status acpi_ex_opcode_3A_1T_1R(struct acpi_walk_state *walk_state);
44f6c012 RM	335
	336	/*
	337	* exoparg6 - ACPI AML execution, 6 operands
1da177e4	338	*/
4be44fcd	339	acpi_status acpi_ex_opcode_6A_0T_1R(struct acpi_walk_state *walk_state);
1da177e4	340
44f6c012 RM	341	/*
	342	* exresolv - Object resolution and get value functions
	343	*/
1da177e4	344	acpi_status
4be44fcd LB	345	acpi_ex_resolve_to_value(union acpi_operand_object **stack_ptr,
4be44fcd LB	346	struct acpi_walk_state *walk_state);
1da177e4 LT	347
1da177e4 LT	348	acpi_status
4be44fcd LB	349	acpi_ex_resolve_multiple(struct acpi_walk_state *walk_state,
	350	union acpi_operand_object *operand,
	351	acpi_object_type * return_type,
	352	union acpi_operand_object **return_desc);
44f6c012 RM	353
	354	/*
	355	* exresnte - resolve namespace node
	356	*/
	357	acpi_status
4be44fcd LB	358	acpi_ex_resolve_node_to_value(struct acpi_namespace_node **stack_ptr,
4be44fcd LB	359	struct acpi_walk_state *walk_state);
44f6c012 RM	360
	361	/*
	362	* exresop - resolve operand to value
	363	*/
1da177e4	364	acpi_status
4be44fcd LB	365	acpi_ex_resolve_operands(u16 opcode,
	366	union acpi_operand_object **stack_ptr,
	367	struct acpi_walk_state *walk_state);
1da177e4 LT	368
	369	/*
	370	* exdump - Interpreter debug output routines
	371	*/
4be44fcd	372	void acpi_ex_dump_operand(union acpi_operand_object *obj_desc, u32 depth);
1da177e4 LT	373
1da177e4 LT	374	void
4be44fcd	375	acpi_ex_dump_operands(union acpi_operand_object **operands,
71d993e1	376	const char *opcode_name, u32 num_opcodes);
1da177e4	377
44f6c012	378	#ifdef ACPI_FUTURE_USAGE
1da177e4	379	void
4be44fcd	380	acpi_ex_dump_object_descriptor(union acpi_operand_object *object, u32 flags);
1da177e4	381
96db255c	382	void acpi_ex_dump_namespace_node(struct acpi_namespace_node *node, u32 flags);
4be44fcd	383	#endif /* ACPI_FUTURE_USAGE */
1da177e4 LT	384
1da177e4 LT	385	/*
44f6c012	386	* exnames - AML namestring support
1da177e4	387	*/
1da177e4	388	acpi_status
4be44fcd LB	389	acpi_ex_get_name_string(acpi_object_type data_type,
	390	u8 * in_aml_address,
	391	char *out_name_string, u32 out_name_length);
1da177e4 LT	392
	393	/*
	394	* exstore - Object store support
	395	*/
1da177e4	396	acpi_status
4be44fcd LB	397	acpi_ex_store(union acpi_operand_object *val_desc,
	398	union acpi_operand_object *dest_desc,
	399	struct acpi_walk_state *walk_state);
1da177e4	400
1da177e4	401	acpi_status
4be44fcd LB	402	acpi_ex_store_object_to_node(union acpi_operand_object *source_desc,
	403	struct acpi_namespace_node *node,
	404	struct acpi_walk_state *walk_state,
	405	u8 implicit_conversion);
1da177e4 LT	406
	407	#define ACPI_IMPLICIT_CONVERSION TRUE
	408	#define ACPI_NO_IMPLICIT_CONVERSION FALSE
	409
	410	/*
44f6c012	411	* exstoren - resolve/store object
1da177e4	412	*/
1da177e4	413	acpi_status
4be44fcd LB	414	acpi_ex_resolve_object(union acpi_operand_object **source_desc_ptr,
	415	acpi_object_type target_type,
	416	struct acpi_walk_state *walk_state);
1da177e4 LT	417
1da177e4 LT	418	acpi_status
4be44fcd LB	419	acpi_ex_store_object_to_object(union acpi_operand_object *source_desc,
	420	union acpi_operand_object *dest_desc,
	421	union acpi_operand_object **new_desc,
	422	struct acpi_walk_state *walk_state);
1da177e4 LT	423
1da177e4 LT	424	/*
44f6c012	425	* exstorob - store object - buffer/string
1da177e4	426	*/
1da177e4	427	acpi_status
4be44fcd LB	428	acpi_ex_store_buffer_to_buffer(union acpi_operand_object *source_desc,
4be44fcd LB	429	union acpi_operand_object *target_desc);
1da177e4 LT	430
1da177e4 LT	431	acpi_status
4be44fcd LB	432	acpi_ex_store_string_to_string(union acpi_operand_object *source_desc,
4be44fcd LB	433	union acpi_operand_object *target_desc);
44f6c012 RM	434
	435	/*
	436	* excopy - object copy
	437	*/
1da177e4	438	acpi_status
4be44fcd LB	439	acpi_ex_copy_integer_to_index_field(union acpi_operand_object *source_desc,
4be44fcd LB	440	union acpi_operand_object *target_desc);
1da177e4 LT	441
1da177e4 LT	442	acpi_status
4be44fcd LB	443	acpi_ex_copy_integer_to_bank_field(union acpi_operand_object *source_desc,
4be44fcd LB	444	union acpi_operand_object *target_desc);
1da177e4 LT	445
1da177e4 LT	446	acpi_status
4be44fcd LB	447	acpi_ex_copy_data_to_named_field(union acpi_operand_object *source_desc,
4be44fcd LB	448	struct acpi_namespace_node *node);
1da177e4 LT	449
1da177e4 LT	450	acpi_status
4be44fcd LB	451	acpi_ex_copy_integer_to_buffer_field(union acpi_operand_object *source_desc,
4be44fcd LB	452	union acpi_operand_object *target_desc);
44f6c012	453
1da177e4 LT	454	/*
	455	* exutils - interpreter/scanner utilities
	456	*/
4d2acd9e	457	void acpi_ex_enter_interpreter(void);
1da177e4	458
4be44fcd	459	void acpi_ex_exit_interpreter(void);
1da177e4	460
ef42e53f	461	u8 acpi_ex_truncate_for32bit_table(union acpi_operand_object *obj_desc);
1da177e4	462
ba886cd4	463	void acpi_ex_acquire_global_lock(u32 rule);
1da177e4	464
f02e9fa1	465	void acpi_ex_release_global_lock(u32 rule);
1da177e4	466
5df7e6cb	467	void acpi_ex_eisa_id_to_string(char *dest, u64 compressed_id);
1da177e4	468
5df7e6cb	469	void acpi_ex_integer_to_string(char *dest, u64 value);
1da177e4	470
f65358e5 SS	471	void acpi_ex_pci_cls_to_string(char *dest, u8 class_code[3]);
f65358e5 SS	472
ec463666 BM	473	u8 acpi_is_valid_space_id(u8 space_id);
ec463666 BM	474
1da177e4 LT	475	/*
	476	* exregion - default op_region handlers
	477	*/
1da177e4	478	acpi_status
4be44fcd LB	479	acpi_ex_system_memory_space_handler(u32 function,
	480	acpi_physical_address address,
	481	u32 bit_width,
5df7e6cb	482	u64 *value,
4be44fcd LB	483	void *handler_context,
	484	void *region_context);
	485
	486	acpi_status
	487	acpi_ex_system_io_space_handler(u32 function,
	488	acpi_physical_address address,
	489	u32 bit_width,
5df7e6cb	490	u64 *value,
4be44fcd LB	491	void handler_context, void region_context);
	492
	493	acpi_status
	494	acpi_ex_pci_config_space_handler(u32 function,
	495	acpi_physical_address address,
	496	u32 bit_width,
5df7e6cb	497	u64 *value,
4be44fcd LB	498	void handler_context, void region_context);
	499
	500	acpi_status
	501	acpi_ex_cmos_space_handler(u32 function,
	502	acpi_physical_address address,
	503	u32 bit_width,
5df7e6cb	504	u64 *value,
4be44fcd LB	505	void handler_context, void region_context);
	506
	507	acpi_status
	508	acpi_ex_pci_bar_space_handler(u32 function,
	509	acpi_physical_address address,
	510	u32 bit_width,
5df7e6cb	511	u64 *value,
4be44fcd LB	512	void handler_context, void region_context);
	513
	514	acpi_status
	515	acpi_ex_embedded_controller_space_handler(u32 function,
	516	acpi_physical_address address,
	517	u32 bit_width,
5df7e6cb	518	u64 *value,
4be44fcd LB	519	void *handler_context,
	520	void *region_context);
	521
	522	acpi_status
	523	acpi_ex_sm_bus_space_handler(u32 function,
	524	acpi_physical_address address,
	525	u32 bit_width,
5df7e6cb	526	u64 *value,
4be44fcd LB	527	void handler_context, void region_context);
	528
	529	acpi_status
	530	acpi_ex_data_table_space_handler(u32 function,
	531	acpi_physical_address address,
	532	u32 bit_width,
5df7e6cb	533	u64 *value,
4be44fcd LB	534	void handler_context, void region_context);
	535
	536	#endif /* __INTERP_H__ */