[deliverable/linux.git] / include / acpi / acevents.h

/******************************************************************************
 *
 * Name: acevents.h - Event subcomponent prototypes and defines
 *
 *****************************************************************************/

/*
 * Copyright (C) 2000 - 2008, 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 __ACEVENTS_H__
#define __ACEVENTS_H__

/*
 * evevent
 */
acpi_status acpi_ev_initialize_events(void);

acpi_status acpi_ev_install_xrupt_handlers(void);

acpi_status acpi_ev_install_fadt_gpes(void);

u32 acpi_ev_fixed_event_detect(void);

/*
 * evmisc
 */
u8 acpi_ev_is_notify_object(struct acpi_namespace_node *node);

acpi_status acpi_ev_acquire_global_lock(u16 timeout);

acpi_status acpi_ev_release_global_lock(void);

acpi_status acpi_ev_init_global_lock_handler(void);

u32 acpi_ev_get_gpe_number_index(u32 gpe_number);

acpi_status
acpi_ev_queue_notify_request(struct acpi_namespace_node *node,
			     u32 notify_value);

/*
 * evgpe - GPE handling and dispatch
 */
acpi_status
acpi_ev_update_gpe_enable_masks(struct acpi_gpe_event_info *gpe_event_info,
				u8 type);

acpi_status
acpi_ev_enable_gpe(struct acpi_gpe_event_info *gpe_event_info,
		   u8 write_to_hardware);

acpi_status acpi_ev_disable_gpe(struct acpi_gpe_event_info *gpe_event_info);

struct acpi_gpe_event_info *acpi_ev_get_gpe_event_info(acpi_handle gpe_device,
						       u32 gpe_number);

/*
 * evgpeblk
 */
u8 acpi_ev_valid_gpe_event(struct acpi_gpe_event_info *gpe_event_info);

acpi_status acpi_ev_walk_gpe_list(acpi_gpe_callback gpe_walk_callback);

acpi_status
acpi_ev_delete_gpe_handlers(struct acpi_gpe_xrupt_info *gpe_xrupt_info,
			    struct acpi_gpe_block_info *gpe_block);

acpi_status
acpi_ev_create_gpe_block(struct acpi_namespace_node *gpe_device,
			 struct acpi_generic_address *gpe_block_address,
			 u32 register_count,
			 u8 gpe_block_base_number,
			 u32 interrupt_number,
			 struct acpi_gpe_block_info **return_gpe_block);

acpi_status
acpi_ev_initialize_gpe_block(struct acpi_namespace_node *gpe_device,
			     struct acpi_gpe_block_info *gpe_block);

acpi_status acpi_ev_delete_gpe_block(struct acpi_gpe_block_info *gpe_block);

u32
acpi_ev_gpe_dispatch(struct acpi_gpe_event_info *gpe_event_info,
		     u32 gpe_number);

u32 acpi_ev_gpe_detect(struct acpi_gpe_xrupt_info *gpe_xrupt_list);

acpi_status
acpi_ev_set_gpe_type(struct acpi_gpe_event_info *gpe_event_info, u8 type);

acpi_status
acpi_ev_check_for_wake_only_gpe(struct acpi_gpe_event_info *gpe_event_info);

acpi_status acpi_ev_gpe_initialize(void);

/*
 * evregion - Address Space handling
 */
acpi_status acpi_ev_install_region_handlers(void);

acpi_status acpi_ev_initialize_op_regions(void);

acpi_status
acpi_ev_address_space_dispatch(union acpi_operand_object *region_obj,
			       u32 function,
			       acpi_physical_address address,
			       u32 bit_width, acpi_integer * value);

acpi_status
acpi_ev_attach_region(union acpi_operand_object *handler_obj,
		      union acpi_operand_object *region_obj,
		      u8 acpi_ns_is_locked);

void
acpi_ev_detach_region(union acpi_operand_object *region_obj,
		      u8 acpi_ns_is_locked);

acpi_status
acpi_ev_install_space_handler(struct acpi_namespace_node *node,
			      acpi_adr_space_type space_id,
			      acpi_adr_space_handler handler,
			      acpi_adr_space_setup setup, void *context);

acpi_status
acpi_ev_execute_reg_methods(struct acpi_namespace_node *node,
			    acpi_adr_space_type space_id);

acpi_status
acpi_ev_execute_reg_method(union acpi_operand_object *region_obj, u32 function);

/*
 * evregini - Region initialization and setup
 */
acpi_status
acpi_ev_system_memory_region_setup(acpi_handle handle,
				   u32 function,
				   void *handler_context,
				   void **region_context);

acpi_status
acpi_ev_io_space_region_setup(acpi_handle handle,
			      u32 function,
			      void *handler_context, void **region_context);

acpi_status
acpi_ev_pci_config_region_setup(acpi_handle handle,
				u32 function,
				void *handler_context, void **region_context);

acpi_status
acpi_ev_cmos_region_setup(acpi_handle handle,
			  u32 function,
			  void *handler_context, void **region_context);

acpi_status
acpi_ev_pci_bar_region_setup(acpi_handle handle,
			     u32 function,
			     void *handler_context, void **region_context);

acpi_status
acpi_ev_default_region_setup(acpi_handle handle,
			     u32 function,
			     void *handler_context, void **region_context);

acpi_status
acpi_ev_initialize_region(union acpi_operand_object *region_obj,
			  u8 acpi_ns_locked);

/*
 * evsci - SCI (System Control Interrupt) handling/dispatch
 */
u32 ACPI_SYSTEM_XFACE acpi_ev_gpe_xrupt_handler(void *context);

u32 acpi_ev_install_sci_handler(void);

acpi_status acpi_ev_remove_sci_handler(void);

u32 acpi_ev_initialize_sCI(u32 program_sCI);

void acpi_ev_terminate(void);

#endif				/* __ACEVENTS_H__  */
Commit	Line	Data
1da177e4 LT	1	/******************************************************************************
	2	*
	3	* Name: acevents.h - Event subcomponent prototypes and defines
	4	*
	5	*****************************************************************************/
	6
	7	/*
75a44ce0	8	* Copyright (C) 2000 - 2008, 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 __ACEVENTS_H__
	45	#define __ACEVENTS_H__
	46
44f6c012 RM	47	/*
	48	* evevent
	49	*/
4be44fcd	50	acpi_status acpi_ev_initialize_events(void);
1da177e4	51
4be44fcd	52	acpi_status acpi_ev_install_xrupt_handlers(void);
1da177e4	53
96db255c BM	54	acpi_status acpi_ev_install_fadt_gpes(void);
96db255c BM	55
4be44fcd	56	u32 acpi_ev_fixed_event_detect(void);
1da177e4 LT	57
1da177e4 LT	58	/*
44f6c012	59	* evmisc
1da177e4	60	*/
4be44fcd	61	u8 acpi_ev_is_notify_object(struct acpi_namespace_node *node);
1da177e4	62
4be44fcd	63	acpi_status acpi_ev_acquire_global_lock(u16 timeout);
1da177e4	64
4be44fcd	65	acpi_status acpi_ev_release_global_lock(void);
1da177e4	66
4be44fcd	67	acpi_status acpi_ev_init_global_lock_handler(void);
1da177e4	68
4be44fcd	69	u32 acpi_ev_get_gpe_number_index(u32 gpe_number);
1da177e4 LT	70
1da177e4 LT	71	acpi_status
4be44fcd LB	72	acpi_ev_queue_notify_request(struct acpi_namespace_node *node,
4be44fcd LB	73	u32 notify_value);
1da177e4 LT	74
1da177e4 LT	75	/*
44f6c012	76	* evgpe - GPE handling and dispatch
1da177e4	77	*/
1da177e4	78	acpi_status
4be44fcd LB	79	acpi_ev_update_gpe_enable_masks(struct acpi_gpe_event_info *gpe_event_info,
4be44fcd LB	80	u8 type);
1da177e4 LT	81
1da177e4 LT	82	acpi_status
4be44fcd LB	83	acpi_ev_enable_gpe(struct acpi_gpe_event_info *gpe_event_info,
4be44fcd LB	84	u8 write_to_hardware);
1da177e4	85
4be44fcd	86	acpi_status acpi_ev_disable_gpe(struct acpi_gpe_event_info *gpe_event_info);
1da177e4	87
4be44fcd LB	88	struct acpi_gpe_event_info *acpi_ev_get_gpe_event_info(acpi_handle gpe_device,
4be44fcd LB	89	u32 gpe_number);
44f6c012 RM	90
	91	/*
	92	* evgpeblk
	93	*/
4be44fcd	94	u8 acpi_ev_valid_gpe_event(struct acpi_gpe_event_info *gpe_event_info);
44f6c012	95
61686124	96	acpi_status acpi_ev_walk_gpe_list(acpi_gpe_callback gpe_walk_callback);
1da177e4 LT	97
1da177e4 LT	98	acpi_status
4be44fcd LB	99	acpi_ev_delete_gpe_handlers(struct acpi_gpe_xrupt_info *gpe_xrupt_info,
4be44fcd LB	100	struct acpi_gpe_block_info *gpe_block);
1da177e4 LT	101
1da177e4 LT	102	acpi_status
4be44fcd LB	103	acpi_ev_create_gpe_block(struct acpi_namespace_node *gpe_device,
	104	struct acpi_generic_address *gpe_block_address,
	105	u32 register_count,
	106	u8 gpe_block_base_number,
	107	u32 interrupt_number,
	108	struct acpi_gpe_block_info **return_gpe_block);
1da177e4	109
96db255c BM	110	acpi_status
	111	acpi_ev_initialize_gpe_block(struct acpi_namespace_node *gpe_device,
	112	struct acpi_gpe_block_info *gpe_block);
	113
4be44fcd	114	acpi_status acpi_ev_delete_gpe_block(struct acpi_gpe_block_info *gpe_block);
1da177e4 LT	115
1da177e4 LT	116	u32
4be44fcd LB	117	acpi_ev_gpe_dispatch(struct acpi_gpe_event_info *gpe_event_info,
4be44fcd LB	118	u32 gpe_number);
1da177e4	119
4be44fcd	120	u32 acpi_ev_gpe_detect(struct acpi_gpe_xrupt_info *gpe_xrupt_list);
1da177e4 LT	121
1da177e4 LT	122	acpi_status
4be44fcd	123	acpi_ev_set_gpe_type(struct acpi_gpe_event_info *gpe_event_info, u8 type);
1da177e4	124
44f6c012	125	acpi_status
4be44fcd	126	acpi_ev_check_for_wake_only_gpe(struct acpi_gpe_event_info *gpe_event_info);
44f6c012	127
4be44fcd	128	acpi_status acpi_ev_gpe_initialize(void);
44f6c012	129
1da177e4	130	/*
44f6c012	131	* evregion - Address Space handling
1da177e4	132	*/
4be44fcd	133	acpi_status acpi_ev_install_region_handlers(void);
1da177e4	134
4be44fcd	135	acpi_status acpi_ev_initialize_op_regions(void);
1da177e4 LT	136
1da177e4 LT	137	acpi_status
4be44fcd LB	138	acpi_ev_address_space_dispatch(union acpi_operand_object *region_obj,
	139	u32 function,
	140	acpi_physical_address address,
958dd242	141	u32 bit_width, acpi_integer * value);
1da177e4	142
1da177e4	143	acpi_status
4be44fcd LB	144	acpi_ev_attach_region(union acpi_operand_object *handler_obj,
	145	union acpi_operand_object *region_obj,
	146	u8 acpi_ns_is_locked);
1da177e4 LT	147
1da177e4 LT	148	void
4be44fcd LB	149	acpi_ev_detach_region(union acpi_operand_object *region_obj,
4be44fcd LB	150	u8 acpi_ns_is_locked);
1da177e4 LT	151
1da177e4 LT	152	acpi_status
4be44fcd LB	153	acpi_ev_install_space_handler(struct acpi_namespace_node *node,
	154	acpi_adr_space_type space_id,
	155	acpi_adr_space_handler handler,
	156	acpi_adr_space_setup setup, void *context);
1da177e4 LT	157
1da177e4 LT	158	acpi_status
4be44fcd LB	159	acpi_ev_execute_reg_methods(struct acpi_namespace_node *node,
4be44fcd LB	160	acpi_adr_space_type space_id);
1da177e4 LT	161
1da177e4 LT	162	acpi_status
4be44fcd	163	acpi_ev_execute_reg_method(union acpi_operand_object *region_obj, u32 function);
1da177e4 LT	164
1da177e4 LT	165	/*
44f6c012	166	* evregini - Region initialization and setup
1da177e4	167	*/
1da177e4	168	acpi_status
4be44fcd LB	169	acpi_ev_system_memory_region_setup(acpi_handle handle,
	170	u32 function,
	171	void *handler_context,
	172	void **region_context);
1da177e4 LT	173
1da177e4 LT	174	acpi_status
4be44fcd LB	175	acpi_ev_io_space_region_setup(acpi_handle handle,
	176	u32 function,
	177	void handler_context, void *region_context);
1da177e4 LT	178
1da177e4 LT	179	acpi_status
4be44fcd LB	180	acpi_ev_pci_config_region_setup(acpi_handle handle,
	181	u32 function,
	182	void handler_context, void *region_context);
1da177e4 LT	183
1da177e4 LT	184	acpi_status
4be44fcd LB	185	acpi_ev_cmos_region_setup(acpi_handle handle,
	186	u32 function,
	187	void handler_context, void *region_context);
1da177e4 LT	188
1da177e4 LT	189	acpi_status
4be44fcd LB	190	acpi_ev_pci_bar_region_setup(acpi_handle handle,
	191	u32 function,
	192	void handler_context, void *region_context);
1da177e4 LT	193
1da177e4 LT	194	acpi_status
4be44fcd LB	195	acpi_ev_default_region_setup(acpi_handle handle,
	196	u32 function,
	197	void handler_context, void *region_context);
1da177e4 LT	198
1da177e4 LT	199	acpi_status
4be44fcd LB	200	acpi_ev_initialize_region(union acpi_operand_object *region_obj,
4be44fcd LB	201	u8 acpi_ns_locked);
1da177e4 LT	202
1da177e4 LT	203	/*
44f6c012	204	* evsci - SCI (System Control Interrupt) handling/dispatch
1da177e4	205	*/
4be44fcd	206	u32 ACPI_SYSTEM_XFACE acpi_ev_gpe_xrupt_handler(void *context);
1da177e4	207
4be44fcd	208	u32 acpi_ev_install_sci_handler(void);
1da177e4	209
4be44fcd	210	acpi_status acpi_ev_remove_sci_handler(void);
1da177e4	211
4be44fcd	212	u32 acpi_ev_initialize_sCI(u32 program_sCI);
1da177e4	213
4be44fcd	214	void acpi_ev_terminate(void);
1da177e4	215
4be44fcd	216	#endif /* __ACEVENTS_H__ */