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

/******************************************************************************
 *
 * Name: acevents.h - Event 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 __ACEVENTS_H__
#define __ACEVENTS_H__

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

acpi_status acpi_ev_install_xrupt_handlers(void);

u32 acpi_ev_fixed_event_detect(void);

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

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

/*
 * evglock - Global Lock support
 */
acpi_status acpi_ev_init_global_lock_handler(void);

ACPI_HW_DEPENDENT_RETURN_OK(acpi_status
			    acpi_ev_acquire_global_lock(u16 timeout))
ACPI_HW_DEPENDENT_RETURN_OK(acpi_status acpi_ev_release_global_lock(void))
acpi_status acpi_ev_remove_global_lock_handler(void);

/*
 * evgpe - Low-level GPE support
 */
u32 acpi_ev_gpe_detect(struct acpi_gpe_xrupt_info *gpe_xrupt_list);

acpi_status
acpi_ev_update_gpe_enable_mask(struct acpi_gpe_event_info *gpe_event_info);

acpi_status acpi_ev_enable_gpe(struct acpi_gpe_event_info *gpe_event_info);

acpi_status
acpi_ev_add_gpe_reference(struct acpi_gpe_event_info *gpe_event_info);

acpi_status
acpi_ev_remove_gpe_reference(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);

struct acpi_gpe_event_info *acpi_ev_low_get_gpe_info(u32 gpe_number,
						     struct acpi_gpe_block_info
						     *gpe_block);

acpi_status acpi_ev_finish_gpe(struct acpi_gpe_event_info *gpe_event_info);

/*
 * evgpeblk - Upper-level GPE block support
 */
acpi_status
acpi_ev_create_gpe_block(struct acpi_namespace_node *gpe_device,
			 u64 address,
			 u8 space_id,
			 u32 register_count,
			 u16 gpe_block_base_number,
			 u32 interrupt_number,
			 struct acpi_gpe_block_info **return_gpe_block);

acpi_status
acpi_ev_initialize_gpe_block(struct acpi_gpe_xrupt_info *gpe_xrupt_info,
			     struct acpi_gpe_block_info *gpe_block,
			     void *context);

ACPI_HW_DEPENDENT_RETURN_OK(acpi_status
			    acpi_ev_delete_gpe_block(struct acpi_gpe_block_info
						     *gpe_block))

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

/*
 * evgpeinit - GPE initialization and update
 */
acpi_status acpi_ev_gpe_initialize(void);

ACPI_HW_DEPENDENT_RETURN_VOID(void
			      acpi_ev_update_gpes(acpi_owner_id table_owner_id))

acpi_status
acpi_ev_match_gpe_method(acpi_handle obj_handle,
			 u32 level, void *context, void **return_value);

/*
 * evgpeutil - GPE utilities
 */
acpi_status
acpi_ev_walk_gpe_list(acpi_gpe_callback gpe_walk_callback, void *context);

acpi_status
acpi_ev_get_gpe_device(struct acpi_gpe_xrupt_info *gpe_xrupt_info,
		       struct acpi_gpe_block_info *gpe_block, void *context);

acpi_status
acpi_ev_get_gpe_xrupt_block(u32 interrupt_number,
			    struct acpi_gpe_xrupt_info **gpe_xrupt_block);

acpi_status acpi_ev_delete_gpe_xrupt(struct acpi_gpe_xrupt_info *gpe_xrupt);

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

/*
 * evhandler - Address space handling
 */
union acpi_operand_object *acpi_ev_find_region_handler(acpi_adr_space_type
						       space_id,
						       union acpi_operand_object
						       *handler_obj);

u8
acpi_ev_has_default_handler(struct acpi_namespace_node *node,
			    acpi_adr_space_type space_id);

acpi_status acpi_ev_install_region_handlers(void);

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

/*
 * evregion - Operation region support
 */
acpi_status acpi_ev_initialize_op_regions(void);

acpi_status
acpi_ev_address_space_dispatch(union acpi_operand_object *region_obj,
			       union acpi_operand_object *field_obj,
			       u32 function,
			       u32 region_offset, u32 bit_width, u64 *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);

void acpi_ev_associate_reg_method(union acpi_operand_object *region_obj);

void
acpi_ev_execute_reg_methods(struct acpi_namespace_node *node,
			    acpi_adr_space_type space_id, u32 function);

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_sci_dispatch(void);

u32 acpi_ev_install_sci_handler(void);

acpi_status acpi_ev_remove_all_sci_handlers(void);

ACPI_HW_DEPENDENT_RETURN_VOID(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	/*
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 __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
4be44fcd	54	u32 acpi_ev_fixed_event_detect(void);
1da177e4 LT	55
1da177e4 LT	56	/*
44f6c012	57	* evmisc
1da177e4	58	*/
4be44fcd	59	u8 acpi_ev_is_notify_object(struct acpi_namespace_node *node);
1da177e4	60
4be44fcd	61	u32 acpi_ev_get_gpe_number_index(u32 gpe_number);
1da177e4 LT	62
1da177e4 LT	63	acpi_status
4be44fcd LB	64	acpi_ev_queue_notify_request(struct acpi_namespace_node *node,
4be44fcd LB	65	u32 notify_value);
1da177e4	66
0f6896f1 BM	67	/*
	68	* evglock - Global Lock support
	69	*/
	70	acpi_status acpi_ev_init_global_lock_handler(void);
	71
33620c54 BM	72	ACPI_HW_DEPENDENT_RETURN_OK(acpi_status
33620c54 BM	73	acpi_ev_acquire_global_lock(u16 timeout))
cd27d79f	74	ACPI_HW_DEPENDENT_RETURN_OK(acpi_status acpi_ev_release_global_lock(void))
ed606944	75	acpi_status acpi_ev_remove_global_lock_handler(void);
0f6896f1	76
1da177e4	77	/*
3fe50208	78	* evgpe - Low-level GPE support
1da177e4	79	*/
3fe50208 BM	80	u32 acpi_ev_gpe_detect(struct acpi_gpe_xrupt_info *gpe_xrupt_list);
3fe50208 BM	81
1da177e4	82	acpi_status
a44061aa	83	acpi_ev_update_gpe_enable_mask(struct acpi_gpe_event_info *gpe_event_info);
1da177e4	84
3bd741bd	85	acpi_status acpi_ev_enable_gpe(struct acpi_gpe_event_info *gpe_event_info);
28f4f8a9	86
1f86e8c1 LZ	87	acpi_status
1f86e8c1 LZ	88	acpi_ev_add_gpe_reference(struct acpi_gpe_event_info *gpe_event_info);
28f4f8a9	89
1f86e8c1 LZ	90	acpi_status
1f86e8c1 LZ	91	acpi_ev_remove_gpe_reference(struct acpi_gpe_event_info *gpe_event_info);
3bd741bd	92
4be44fcd LB	93	struct acpi_gpe_event_info *acpi_ev_get_gpe_event_info(acpi_handle gpe_device,
4be44fcd LB	94	u32 gpe_number);
44f6c012	95
0f849d2c LM	96	struct acpi_gpe_event_info *acpi_ev_low_get_gpe_info(u32 gpe_number,
	97	struct acpi_gpe_block_info
	98	*gpe_block);
	99
bba63a29 LM	100	acpi_status acpi_ev_finish_gpe(struct acpi_gpe_event_info *gpe_event_info);
bba63a29 LM	101
44f6c012	102	/*
3fe50208	103	* evgpeblk - Upper-level GPE block support
44f6c012	104	*/
1da177e4	105	acpi_status
4be44fcd	106	acpi_ev_create_gpe_block(struct acpi_namespace_node *gpe_device,
7505da4c BM	107	u64 address,
7505da4c BM	108	u8 space_id,
4be44fcd	109	u32 register_count,
7505da4c	110	u16 gpe_block_base_number,
4be44fcd LB	111	u32 interrupt_number,
4be44fcd LB	112	struct acpi_gpe_block_info **return_gpe_block);
1da177e4	113
96db255c	114	acpi_status
a2100801 RW	115	acpi_ev_initialize_gpe_block(struct acpi_gpe_xrupt_info *gpe_xrupt_info,
a2100801 RW	116	struct acpi_gpe_block_info *gpe_block,
3a37898d	117	void *context);
96db255c	118
33620c54 BM	119	ACPI_HW_DEPENDENT_RETURN_OK(acpi_status
	120	acpi_ev_delete_gpe_block(struct acpi_gpe_block_info
	121	*gpe_block))
1da177e4 LT	122
1da177e4 LT	123	u32
8b6cd8ad LM	124	acpi_ev_gpe_dispatch(struct acpi_namespace_node *gpe_device,
8b6cd8ad LM	125	struct acpi_gpe_event_info *gpe_event_info,
4be44fcd	126	u32 gpe_number);
1da177e4	127
3fe50208 BM	128	/*
	129	* evgpeinit - GPE initialization and update
	130	*/
4be44fcd	131	acpi_status acpi_ev_gpe_initialize(void);
44f6c012	132
33620c54 BM	133	ACPI_HW_DEPENDENT_RETURN_VOID(void
33620c54 BM	134	acpi_ev_update_gpes(acpi_owner_id table_owner_id))
3fe50208	135
ed606944	136	acpi_status
3fe50208 BM	137	acpi_ev_match_gpe_method(acpi_handle obj_handle,
	138	u32 level, void context, void *return_value);
	139
3fe50208 BM	140	/*
	141	* evgpeutil - GPE utilities
	142	*/
	143	acpi_status
	144	acpi_ev_walk_gpe_list(acpi_gpe_callback gpe_walk_callback, void *context);
	145
3cfd53d5 LM	146	acpi_status
	147	acpi_ev_get_gpe_device(struct acpi_gpe_xrupt_info *gpe_xrupt_info,
	148	struct acpi_gpe_block_info gpe_block, void context);
	149
4bec3d80 BM	150	acpi_status
	151	acpi_ev_get_gpe_xrupt_block(u32 interrupt_number,
	152	struct acpi_gpe_xrupt_info **gpe_xrupt_block);
3fe50208 BM	153
	154	acpi_status acpi_ev_delete_gpe_xrupt(struct acpi_gpe_xrupt_info *gpe_xrupt);
	155
	156	acpi_status
	157	acpi_ev_delete_gpe_handlers(struct acpi_gpe_xrupt_info *gpe_xrupt_info,
	158	struct acpi_gpe_block_info *gpe_block,
	159	void *context);
	160
1da177e4	161	/*
42f8fb75	162	* evhandler - Address space handling
1da177e4	163	*/
f31a99ce LZ	164	union acpi_operand_object *acpi_ev_find_region_handler(acpi_adr_space_type
	165	space_id,
	166	union acpi_operand_object
	167	*handler_obj);
	168
42f8fb75 BM	169	u8
	170	acpi_ev_has_default_handler(struct acpi_namespace_node *node,
	171	acpi_adr_space_type space_id);
	172
4be44fcd	173	acpi_status acpi_ev_install_region_handlers(void);
1da177e4	174
42f8fb75 BM	175	acpi_status
	176	acpi_ev_install_space_handler(struct acpi_namespace_node *node,
	177	acpi_adr_space_type space_id,
	178	acpi_adr_space_handler handler,
	179	acpi_adr_space_setup setup, void *context);
	180
	181	/*
	182	* evregion - Operation region support
	183	*/
4be44fcd	184	acpi_status acpi_ev_initialize_op_regions(void);
1da177e4 LT	185
1da177e4 LT	186	acpi_status
4be44fcd	187	acpi_ev_address_space_dispatch(union acpi_operand_object *region_obj,
9ce81784	188	union acpi_operand_object *field_obj,
4be44fcd	189	u32 function,
5df7e6cb	190	u32 region_offset, u32 bit_width, u64 *value);
1da177e4	191
1da177e4	192	acpi_status
4be44fcd LB	193	acpi_ev_attach_region(union acpi_operand_object *handler_obj,
	194	union acpi_operand_object *region_obj,
	195	u8 acpi_ns_is_locked);
1da177e4 LT	196
1da177e4 LT	197	void
4be44fcd LB	198	acpi_ev_detach_region(union acpi_operand_object *region_obj,
4be44fcd LB	199	u8 acpi_ns_is_locked);
1da177e4	200
849c2571 LZ	201	void acpi_ev_associate_reg_method(union acpi_operand_object *region_obj);
849c2571 LZ	202
d815346f	203	void
4be44fcd	204	acpi_ev_execute_reg_methods(struct acpi_namespace_node *node,
d815346f	205	acpi_adr_space_type space_id, u32 function);
1da177e4 LT	206
1da177e4 LT	207	acpi_status
4be44fcd	208	acpi_ev_execute_reg_method(union acpi_operand_object *region_obj, u32 function);
1da177e4 LT	209
1da177e4 LT	210	/*
44f6c012	211	* evregini - Region initialization and setup
1da177e4	212	*/
1da177e4	213	acpi_status
4be44fcd LB	214	acpi_ev_system_memory_region_setup(acpi_handle handle,
	215	u32 function,
	216	void *handler_context,
	217	void **region_context);
1da177e4 LT	218
1da177e4 LT	219	acpi_status
4be44fcd LB	220	acpi_ev_io_space_region_setup(acpi_handle handle,
	221	u32 function,
	222	void handler_context, void *region_context);
1da177e4 LT	223
1da177e4 LT	224	acpi_status
4be44fcd LB	225	acpi_ev_pci_config_region_setup(acpi_handle handle,
	226	u32 function,
	227	void handler_context, void *region_context);
1da177e4 LT	228
1da177e4 LT	229	acpi_status
4be44fcd LB	230	acpi_ev_cmos_region_setup(acpi_handle handle,
	231	u32 function,
	232	void handler_context, void *region_context);
1da177e4 LT	233
1da177e4 LT	234	acpi_status
4be44fcd LB	235	acpi_ev_pci_bar_region_setup(acpi_handle handle,
	236	u32 function,
	237	void handler_context, void *region_context);
1da177e4 LT	238
1da177e4 LT	239	acpi_status
4be44fcd LB	240	acpi_ev_default_region_setup(acpi_handle handle,
	241	u32 function,
	242	void handler_context, void *region_context);
1da177e4 LT	243
1da177e4 LT	244	acpi_status
4be44fcd LB	245	acpi_ev_initialize_region(union acpi_operand_object *region_obj,
4be44fcd LB	246	u8 acpi_ns_locked);
1da177e4 LT	247
1da177e4 LT	248	/*
44f6c012	249	* evsci - SCI (System Control Interrupt) handling/dispatch
1da177e4	250	*/
4be44fcd	251	u32 ACPI_SYSTEM_XFACE acpi_ev_gpe_xrupt_handler(void *context);
1da177e4	252
a2fd4b4b	253	u32 acpi_ev_sci_dispatch(void);
1da177e4	254
a2fd4b4b	255	u32 acpi_ev_install_sci_handler(void);
1da177e4	256
a2fd4b4b	257	acpi_status acpi_ev_remove_all_sci_handlers(void);
1da177e4	258
33620c54	259	ACPI_HW_DEPENDENT_RETURN_VOID(void acpi_ev_terminate(void))
4be44fcd	260	#endif /* __ACEVENTS_H__ */