[deliverable/linux.git] / drivers / acpi / acpica / acinterp.h

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

/*
 * Copyright (C) 2000 - 2016, 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;
	const 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);

void
acpi_ex_start_trace_method(struct acpi_namespace_node *method_node,
			   union acpi_operand_object *obj_desc,
			   struct acpi_walk_state *walk_state);

void
acpi_ex_stop_trace_method(struct acpi_namespace_node *method_node,
			  union acpi_operand_object *obj_desc,
			  struct acpi_walk_state *walk_state);

void
acpi_ex_start_trace_opcode(union acpi_parse_object *op,
			   struct acpi_walk_state *walk_state);

void
acpi_ex_stop_trace_opcode(union acpi_parse_object *op,
			  struct acpi_walk_state *walk_state);

void
acpi_ex_trace_point(acpi_trace_event_type type,
		    u8 begin, u8 *aml, char *pathname);

/*
 * 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);

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);

/*
 * 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	/*
c8100dc4	8	* Copyright (C) 2000 - 2016, 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;
0dfaaa3d	70	const char *name;
96db255c BM	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
ab6c5733 LZ	134	void
	135	acpi_ex_start_trace_method(struct acpi_namespace_node *method_node,
	136	union acpi_operand_object *obj_desc,
	137	struct acpi_walk_state *walk_state);
	138
	139	void
	140	acpi_ex_stop_trace_method(struct acpi_namespace_node *method_node,
	141	union acpi_operand_object *obj_desc,
	142	struct acpi_walk_state *walk_state);
	143
	144	void
	145	acpi_ex_start_trace_opcode(union acpi_parse_object *op,
	146	struct acpi_walk_state *walk_state);
	147
	148	void
	149	acpi_ex_stop_trace_opcode(union acpi_parse_object *op,
	150	struct acpi_walk_state *walk_state);
	151
bab04824 LZ	152	void
	153	acpi_ex_trace_point(acpi_trace_event_type type,
	154	u8 begin, u8 aml, char pathname);
	155
1da177e4 LT	156	/*
	157	* exfield - ACPI AML (p-code) execution - field manipulation
	158	*/
1da177e4	159	acpi_status
4be44fcd LB	160	acpi_ex_common_buffer_setup(union acpi_operand_object *obj_desc,
4be44fcd LB	161	u32 buffer_length, u32 * datum_count);
1da177e4	162
1da177e4	163	acpi_status
4be44fcd	164	acpi_ex_write_with_update_rule(union acpi_operand_object *obj_desc,
5df7e6cb BM	165	u64 mask,
5df7e6cb BM	166	u64 field_value, u32 field_datum_byte_offset);
1da177e4 LT	167
1da177e4 LT	168	void
5df7e6cb	169	acpi_ex_get_buffer_datum(u64 *datum,
4be44fcd LB	170	void *buffer,
	171	u32 buffer_length,
	172	u32 byte_granularity, u32 buffer_offset);
1da177e4 LT	173
1da177e4 LT	174	void
5df7e6cb	175	acpi_ex_set_buffer_datum(u64 merged_datum,
4be44fcd LB	176	void *buffer,
	177	u32 buffer_length,
	178	u32 byte_granularity, u32 buffer_offset);
1da177e4 LT	179
1da177e4 LT	180	acpi_status
4be44fcd LB	181	acpi_ex_read_data_from_field(struct acpi_walk_state *walk_state,
	182	union acpi_operand_object *obj_desc,
	183	union acpi_operand_object **ret_buffer_desc);
1da177e4 LT	184
1da177e4 LT	185	acpi_status
4be44fcd LB	186	acpi_ex_write_data_to_field(union acpi_operand_object *source_desc,
	187	union acpi_operand_object *obj_desc,
	188	union acpi_operand_object **result_desc);
44f6c012	189
1da177e4	190	/*
44f6c012	191	* exfldio - low level field I/O
1da177e4	192	*/
1da177e4	193	acpi_status
4be44fcd LB	194	acpi_ex_extract_from_field(union acpi_operand_object *obj_desc,
4be44fcd LB	195	void *buffer, u32 buffer_length);
1da177e4 LT	196
1da177e4 LT	197	acpi_status
4be44fcd LB	198	acpi_ex_insert_into_field(union acpi_operand_object *obj_desc,
4be44fcd LB	199	void *buffer, u32 buffer_length);
1da177e4 LT	200
1da177e4 LT	201	acpi_status
4be44fcd	202	acpi_ex_access_region(union acpi_operand_object *obj_desc,
5df7e6cb	203	u32 field_datum_byte_offset, u64 *value, u32 read_write);
1da177e4	204
44f6c012 RM	205	/*
	206	* exmisc - misc support routines
	207	*/
1da177e4	208	acpi_status
4be44fcd LB	209	acpi_ex_get_object_reference(union acpi_operand_object *obj_desc,
	210	union acpi_operand_object **return_desc,
	211	struct acpi_walk_state *walk_state);
1da177e4	212
1da177e4	213	acpi_status
4be44fcd LB	214	acpi_ex_concat_template(union acpi_operand_object *obj_desc,
	215	union acpi_operand_object *obj_desc2,
	216	union acpi_operand_object **actual_return_desc,
	217	struct acpi_walk_state *walk_state);
1da177e4 LT	218
1da177e4 LT	219	acpi_status
4be44fcd LB	220	acpi_ex_do_concatenate(union acpi_operand_object *obj_desc,
	221	union acpi_operand_object *obj_desc2,
	222	union acpi_operand_object **actual_return_desc,
	223	struct acpi_walk_state *walk_state);
1da177e4 LT	224
1da177e4 LT	225	acpi_status
4be44fcd	226	acpi_ex_do_logical_numeric_op(u16 opcode,
5df7e6cb	227	u64 integer0, u64 integer1, u8 *logical_result);
1da177e4 LT	228
1da177e4 LT	229	acpi_status
4be44fcd LB	230	acpi_ex_do_logical_op(u16 opcode,
4be44fcd LB	231	union acpi_operand_object *operand0,
5df7e6cb	232	union acpi_operand_object operand1, u8 logical_result);
1da177e4	233
5df7e6cb	234	u64 acpi_ex_do_math_op(u16 opcode, u64 operand0, u64 operand1);
1da177e4	235
4be44fcd	236	acpi_status acpi_ex_create_mutex(struct acpi_walk_state *walk_state);
1da177e4	237
4be44fcd	238	acpi_status acpi_ex_create_processor(struct acpi_walk_state *walk_state);
1da177e4	239
4be44fcd	240	acpi_status acpi_ex_create_power_resource(struct acpi_walk_state *walk_state);
1da177e4 LT	241
1da177e4 LT	242	acpi_status
4be44fcd LB	243	acpi_ex_create_region(u8 * aml_start,
	244	u32 aml_length,
	245	u8 region_space, struct acpi_walk_state *walk_state);
1da177e4	246
4be44fcd	247	acpi_status acpi_ex_create_event(struct acpi_walk_state *walk_state);
1da177e4	248
4be44fcd	249	acpi_status acpi_ex_create_alias(struct acpi_walk_state *walk_state);
1da177e4 LT	250
1da177e4 LT	251	acpi_status
4be44fcd LB	252	acpi_ex_create_method(u8 * aml_start,
4be44fcd LB	253	u32 aml_length, struct acpi_walk_state *walk_state);
1da177e4 LT	254
	255	/*
	256	* exconfig - dynamic table load/unload
	257	*/
1da177e4	258	acpi_status
4be44fcd LB	259	acpi_ex_load_op(union acpi_operand_object *obj_desc,
	260	union acpi_operand_object *target,
	261	struct acpi_walk_state *walk_state);
1da177e4 LT	262
1da177e4 LT	263	acpi_status
4be44fcd LB	264	acpi_ex_load_table_op(struct acpi_walk_state *walk_state,
4be44fcd LB	265	union acpi_operand_object **return_desc);
1da177e4	266
4be44fcd	267	acpi_status acpi_ex_unload_table(union acpi_operand_object *ddb_handle);
1da177e4 LT	268
	269	/*
	270	* exmutex - mutex support
	271	*/
1da177e4	272	acpi_status
4be44fcd LB	273	acpi_ex_acquire_mutex(union acpi_operand_object *time_desc,
	274	union acpi_operand_object *obj_desc,
	275	struct acpi_walk_state *walk_state);
1da177e4	276
ba886cd4 BM	277	acpi_status
	278	acpi_ex_acquire_mutex_object(u16 timeout,
	279	union acpi_operand_object *obj_desc,
	280	acpi_thread_id thread_id);
	281
1da177e4	282	acpi_status
4be44fcd LB	283	acpi_ex_release_mutex(union acpi_operand_object *obj_desc,
4be44fcd LB	284	struct acpi_walk_state *walk_state);
1da177e4	285
ba886cd4 BM	286	acpi_status acpi_ex_release_mutex_object(union acpi_operand_object *obj_desc);
ba886cd4 BM	287
4be44fcd	288	void acpi_ex_release_all_mutexes(struct acpi_thread_state *thread);
1da177e4	289
262a7a28	290	void acpi_ex_unlink_mutex(union acpi_operand_object *obj_desc);
1da177e4 LT	291
1da177e4 LT	292	/*
44f6c012	293	* exprep - ACPI AML execution - prep utilities
1da177e4	294	*/
1da177e4	295	acpi_status
4be44fcd LB	296	acpi_ex_prep_common_field_object(union acpi_operand_object *obj_desc,
	297	u8 field_flags,
	298	u8 field_attribute,
	299	u32 field_bit_position, u32 field_bit_length);
1da177e4	300
4be44fcd	301	acpi_status acpi_ex_prep_field_value(struct acpi_create_field_info *info);
44f6c012	302
1da177e4 LT	303	/*
	304	* exsystem - Interface to OS services
	305	*/
1da177e4	306	acpi_status
4be44fcd LB	307	acpi_ex_system_do_notify_op(union acpi_operand_object *value,
4be44fcd LB	308	union acpi_operand_object *obj_desc);
1da177e4	309
ada241dc	310	acpi_status acpi_ex_system_do_sleep(u64 time);
1da177e4	311
4be44fcd	312	acpi_status acpi_ex_system_do_stall(u32 time);
1da177e4	313
4be44fcd	314	acpi_status acpi_ex_system_signal_event(union acpi_operand_object *obj_desc);
1da177e4 LT	315
1da177e4 LT	316	acpi_status
4be44fcd LB	317	acpi_ex_system_wait_event(union acpi_operand_object *time,
4be44fcd LB	318	union acpi_operand_object *obj_desc);
1da177e4	319
4be44fcd	320	acpi_status acpi_ex_system_reset_event(union acpi_operand_object *obj_desc);
1da177e4	321
967440e3 BM	322	acpi_status
	323	acpi_ex_system_wait_semaphore(acpi_semaphore semaphore, u16 timeout);
	324
	325	acpi_status acpi_ex_system_wait_mutex(acpi_mutex mutex, u16 timeout);
1da177e4 LT	326
1da177e4 LT	327	/*
44f6c012	328	* exoparg1 - ACPI AML execution, 1 operand
1da177e4	329	*/
4be44fcd	330	acpi_status acpi_ex_opcode_0A_0T_1R(struct acpi_walk_state *walk_state);
1da177e4	331
4be44fcd	332	acpi_status acpi_ex_opcode_1A_0T_0R(struct acpi_walk_state *walk_state);
1da177e4	333
4be44fcd	334	acpi_status acpi_ex_opcode_1A_0T_1R(struct acpi_walk_state *walk_state);
1da177e4	335
4be44fcd	336	acpi_status acpi_ex_opcode_1A_1T_1R(struct acpi_walk_state *walk_state);
1da177e4	337
4be44fcd	338	acpi_status acpi_ex_opcode_1A_1T_0R(struct acpi_walk_state *walk_state);
1da177e4 LT	339
1da177e4 LT	340	/*
44f6c012	341	* exoparg2 - ACPI AML execution, 2 operands
1da177e4	342	*/
4be44fcd	343	acpi_status acpi_ex_opcode_2A_0T_0R(struct acpi_walk_state *walk_state);
1da177e4	344
4be44fcd	345	acpi_status acpi_ex_opcode_2A_0T_1R(struct acpi_walk_state *walk_state);
1da177e4	346
4be44fcd	347	acpi_status acpi_ex_opcode_2A_1T_1R(struct acpi_walk_state *walk_state);
1da177e4	348
4be44fcd	349	acpi_status acpi_ex_opcode_2A_2T_1R(struct acpi_walk_state *walk_state);
1da177e4 LT	350
1da177e4 LT	351	/*
44f6c012 RM	352	* exoparg3 - ACPI AML execution, 3 operands
44f6c012 RM	353	*/
4be44fcd	354	acpi_status acpi_ex_opcode_3A_0T_0R(struct acpi_walk_state *walk_state);
44f6c012	355
4be44fcd	356	acpi_status acpi_ex_opcode_3A_1T_1R(struct acpi_walk_state *walk_state);
44f6c012 RM	357
	358	/*
	359	* exoparg6 - ACPI AML execution, 6 operands
1da177e4	360	*/
4be44fcd	361	acpi_status acpi_ex_opcode_6A_0T_1R(struct acpi_walk_state *walk_state);
1da177e4	362
44f6c012 RM	363	/*
	364	* exresolv - Object resolution and get value functions
	365	*/
1da177e4	366	acpi_status
4be44fcd LB	367	acpi_ex_resolve_to_value(union acpi_operand_object **stack_ptr,
4be44fcd LB	368	struct acpi_walk_state *walk_state);
1da177e4 LT	369
1da177e4 LT	370	acpi_status
4be44fcd LB	371	acpi_ex_resolve_multiple(struct acpi_walk_state *walk_state,
4be44fcd LB	372	union acpi_operand_object *operand,
f5c1e1c5	373	acpi_object_type *return_type,
4be44fcd	374	union acpi_operand_object **return_desc);
44f6c012 RM	375
	376	/*
	377	* exresnte - resolve namespace node
	378	*/
	379	acpi_status
4be44fcd LB	380	acpi_ex_resolve_node_to_value(struct acpi_namespace_node **stack_ptr,
4be44fcd LB	381	struct acpi_walk_state *walk_state);
44f6c012 RM	382
	383	/*
	384	* exresop - resolve operand to value
	385	*/
1da177e4	386	acpi_status
4be44fcd LB	387	acpi_ex_resolve_operands(u16 opcode,
	388	union acpi_operand_object **stack_ptr,
	389	struct acpi_walk_state *walk_state);
1da177e4 LT	390
	391	/*
	392	* exdump - Interpreter debug output routines
	393	*/
4be44fcd	394	void acpi_ex_dump_operand(union acpi_operand_object *obj_desc, u32 depth);
1da177e4 LT	395
1da177e4 LT	396	void
4be44fcd	397	acpi_ex_dump_operands(union acpi_operand_object **operands,
71d993e1	398	const char *opcode_name, u32 num_opcodes);
1da177e4	399
1da177e4	400	void
4be44fcd	401	acpi_ex_dump_object_descriptor(union acpi_operand_object *object, u32 flags);
1da177e4	402
96db255c	403	void acpi_ex_dump_namespace_node(struct acpi_namespace_node *node, u32 flags);
1da177e4 LT	404
1da177e4 LT	405	/*
44f6c012	406	* exnames - AML namestring support
1da177e4	407	*/
1da177e4	408	acpi_status
4be44fcd LB	409	acpi_ex_get_name_string(acpi_object_type data_type,
	410	u8 * in_aml_address,
	411	char *out_name_string, u32 out_name_length);
1da177e4 LT	412
	413	/*
	414	* exstore - Object store support
	415	*/
1da177e4	416	acpi_status
4be44fcd LB	417	acpi_ex_store(union acpi_operand_object *val_desc,
	418	union acpi_operand_object *dest_desc,
	419	struct acpi_walk_state *walk_state);
1da177e4	420
1da177e4	421	acpi_status
4be44fcd LB	422	acpi_ex_store_object_to_node(union acpi_operand_object *source_desc,
	423	struct acpi_namespace_node *node,
	424	struct acpi_walk_state *walk_state,
	425	u8 implicit_conversion);
1da177e4 LT	426
	427	#define ACPI_IMPLICIT_CONVERSION TRUE
	428	#define ACPI_NO_IMPLICIT_CONVERSION FALSE
	429
	430	/*
44f6c012	431	* exstoren - resolve/store object
1da177e4	432	*/
1da177e4	433	acpi_status
4be44fcd LB	434	acpi_ex_resolve_object(union acpi_operand_object **source_desc_ptr,
	435	acpi_object_type target_type,
	436	struct acpi_walk_state *walk_state);
1da177e4 LT	437
1da177e4 LT	438	acpi_status
4be44fcd LB	439	acpi_ex_store_object_to_object(union acpi_operand_object *source_desc,
	440	union acpi_operand_object *dest_desc,
	441	union acpi_operand_object **new_desc,
	442	struct acpi_walk_state *walk_state);
1da177e4 LT	443
1da177e4 LT	444	/*
44f6c012	445	* exstorob - store object - buffer/string
1da177e4	446	*/
1da177e4	447	acpi_status
4be44fcd LB	448	acpi_ex_store_buffer_to_buffer(union acpi_operand_object *source_desc,
4be44fcd LB	449	union acpi_operand_object *target_desc);
1da177e4 LT	450
1da177e4 LT	451	acpi_status
4be44fcd LB	452	acpi_ex_store_string_to_string(union acpi_operand_object *source_desc,
4be44fcd LB	453	union acpi_operand_object *target_desc);
44f6c012 RM	454
	455	/*
	456	* excopy - object copy
	457	*/
1da177e4	458	acpi_status
4be44fcd LB	459	acpi_ex_copy_integer_to_index_field(union acpi_operand_object *source_desc,
4be44fcd LB	460	union acpi_operand_object *target_desc);
1da177e4 LT	461
1da177e4 LT	462	acpi_status
4be44fcd LB	463	acpi_ex_copy_integer_to_bank_field(union acpi_operand_object *source_desc,
4be44fcd LB	464	union acpi_operand_object *target_desc);
1da177e4 LT	465
1da177e4 LT	466	acpi_status
4be44fcd LB	467	acpi_ex_copy_data_to_named_field(union acpi_operand_object *source_desc,
4be44fcd LB	468	struct acpi_namespace_node *node);
1da177e4 LT	469
1da177e4 LT	470	acpi_status
4be44fcd LB	471	acpi_ex_copy_integer_to_buffer_field(union acpi_operand_object *source_desc,
4be44fcd LB	472	union acpi_operand_object *target_desc);
44f6c012	473
1da177e4 LT	474	/*
	475	* exutils - interpreter/scanner utilities
	476	*/
4d2acd9e	477	void acpi_ex_enter_interpreter(void);
1da177e4	478
4be44fcd	479	void acpi_ex_exit_interpreter(void);
1da177e4	480
ef42e53f	481	u8 acpi_ex_truncate_for32bit_table(union acpi_operand_object *obj_desc);
1da177e4	482
ba886cd4	483	void acpi_ex_acquire_global_lock(u32 rule);
1da177e4	484
f02e9fa1	485	void acpi_ex_release_global_lock(u32 rule);
1da177e4	486
5df7e6cb	487	void acpi_ex_eisa_id_to_string(char *dest, u64 compressed_id);
1da177e4	488
5df7e6cb	489	void acpi_ex_integer_to_string(char *dest, u64 value);
1da177e4	490
f65358e5 SS	491	void acpi_ex_pci_cls_to_string(char *dest, u8 class_code[3]);
f65358e5 SS	492
ec463666 BM	493	u8 acpi_is_valid_space_id(u8 space_id);
ec463666 BM	494
1da177e4 LT	495	/*
	496	* exregion - default op_region handlers
	497	*/
1da177e4	498	acpi_status
4be44fcd LB	499	acpi_ex_system_memory_space_handler(u32 function,
	500	acpi_physical_address address,
	501	u32 bit_width,
5df7e6cb	502	u64 *value,
4be44fcd LB	503	void *handler_context,
	504	void *region_context);
	505
	506	acpi_status
	507	acpi_ex_system_io_space_handler(u32 function,
	508	acpi_physical_address address,
	509	u32 bit_width,
5df7e6cb	510	u64 *value,
4be44fcd LB	511	void handler_context, void region_context);
	512
	513	acpi_status
	514	acpi_ex_pci_config_space_handler(u32 function,
	515	acpi_physical_address address,
	516	u32 bit_width,
5df7e6cb	517	u64 *value,
4be44fcd LB	518	void handler_context, void region_context);
	519
	520	acpi_status
	521	acpi_ex_cmos_space_handler(u32 function,
	522	acpi_physical_address address,
	523	u32 bit_width,
5df7e6cb	524	u64 *value,
4be44fcd LB	525	void handler_context, void region_context);
	526
	527	acpi_status
	528	acpi_ex_pci_bar_space_handler(u32 function,
	529	acpi_physical_address address,
	530	u32 bit_width,
5df7e6cb	531	u64 *value,
4be44fcd LB	532	void handler_context, void region_context);
	533
	534	acpi_status
	535	acpi_ex_embedded_controller_space_handler(u32 function,
	536	acpi_physical_address address,
	537	u32 bit_width,
5df7e6cb	538	u64 *value,
4be44fcd LB	539	void *handler_context,
	540	void *region_context);
	541
	542	acpi_status
	543	acpi_ex_sm_bus_space_handler(u32 function,
	544	acpi_physical_address address,
	545	u32 bit_width,
5df7e6cb	546	u64 *value,
4be44fcd LB	547	void handler_context, void region_context);
	548
	549	acpi_status
	550	acpi_ex_data_table_space_handler(u32 function,
	551	acpi_physical_address address,
	552	u32 bit_width,
5df7e6cb	553	u64 *value,
4be44fcd LB	554	void handler_context, void region_context);
	555
	556	#endif /* __INTERP_H__ */