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