[deliverable/linux.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);

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

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