[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_mask_gpe(struct acpi_gpe_event_info *gpe_event_info, u8 is_masked);

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