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