xref: /openbmc/linux/drivers/acpi/acpica/acevents.h (revision 7587eb18)
1 /******************************************************************************
2  *
3  * Name: acevents.h - Event subcomponent prototypes and defines
4  *
5  *****************************************************************************/
6 
7 /*
8  * Copyright (C) 2000 - 2016, 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_HW_DEPENDENT_RETURN_OK(acpi_status
73 			    acpi_ev_acquire_global_lock(u16 timeout))
74 ACPI_HW_DEPENDENT_RETURN_OK(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
89 acpi_ev_add_gpe_reference(struct acpi_gpe_event_info *gpe_event_info);
90 
91 acpi_status
92 acpi_ev_remove_gpe_reference(struct acpi_gpe_event_info *gpe_event_info);
93 
94 struct acpi_gpe_event_info *acpi_ev_get_gpe_event_info(acpi_handle gpe_device,
95 						       u32 gpe_number);
96 
97 struct acpi_gpe_event_info *acpi_ev_low_get_gpe_info(u32 gpe_number,
98 						     struct acpi_gpe_block_info
99 						     *gpe_block);
100 
101 acpi_status acpi_ev_finish_gpe(struct acpi_gpe_event_info *gpe_event_info);
102 
103 /*
104  * evgpeblk - Upper-level GPE block support
105  */
106 acpi_status
107 acpi_ev_create_gpe_block(struct acpi_namespace_node *gpe_device,
108 			 u64 address,
109 			 u8 space_id,
110 			 u32 register_count,
111 			 u16 gpe_block_base_number,
112 			 u32 interrupt_number,
113 			 struct acpi_gpe_block_info **return_gpe_block);
114 
115 acpi_status
116 acpi_ev_initialize_gpe_block(struct acpi_gpe_xrupt_info *gpe_xrupt_info,
117 			     struct acpi_gpe_block_info *gpe_block,
118 			     void *context);
119 
120 ACPI_HW_DEPENDENT_RETURN_OK(acpi_status
121 			    acpi_ev_delete_gpe_block(struct acpi_gpe_block_info
122 						     *gpe_block))
123 
124 u32
125 acpi_ev_gpe_dispatch(struct acpi_namespace_node *gpe_device,
126 		     struct acpi_gpe_event_info *gpe_event_info,
127 		     u32 gpe_number);
128 
129 /*
130  * evgpeinit - GPE initialization and update
131  */
132 acpi_status acpi_ev_gpe_initialize(void);
133 
134 ACPI_HW_DEPENDENT_RETURN_VOID(void
135 			      acpi_ev_update_gpes(acpi_owner_id table_owner_id))
136 
137 acpi_status
138 acpi_ev_match_gpe_method(acpi_handle obj_handle,
139 			 u32 level, void *context, void **return_value);
140 
141 /*
142  * evgpeutil - GPE utilities
143  */
144 acpi_status
145 acpi_ev_walk_gpe_list(acpi_gpe_callback gpe_walk_callback, void *context);
146 
147 acpi_status
148 acpi_ev_get_gpe_device(struct acpi_gpe_xrupt_info *gpe_xrupt_info,
149 		       struct acpi_gpe_block_info *gpe_block, void *context);
150 
151 acpi_status
152 acpi_ev_get_gpe_xrupt_block(u32 interrupt_number,
153 			    struct acpi_gpe_xrupt_info **gpe_xrupt_block);
154 
155 acpi_status acpi_ev_delete_gpe_xrupt(struct acpi_gpe_xrupt_info *gpe_xrupt);
156 
157 acpi_status
158 acpi_ev_delete_gpe_handlers(struct acpi_gpe_xrupt_info *gpe_xrupt_info,
159 			    struct acpi_gpe_block_info *gpe_block,
160 			    void *context);
161 
162 /*
163  * evhandler - Address space handling
164  */
165 union acpi_operand_object *acpi_ev_find_region_handler(acpi_adr_space_type
166 						       space_id,
167 						       union acpi_operand_object
168 						       *handler_obj);
169 
170 u8
171 acpi_ev_has_default_handler(struct acpi_namespace_node *node,
172 			    acpi_adr_space_type space_id);
173 
174 acpi_status acpi_ev_install_region_handlers(void);
175 
176 acpi_status
177 acpi_ev_install_space_handler(struct acpi_namespace_node *node,
178 			      acpi_adr_space_type space_id,
179 			      acpi_adr_space_handler handler,
180 			      acpi_adr_space_setup setup, void *context);
181 
182 /*
183  * evregion - Operation region support
184  */
185 acpi_status acpi_ev_initialize_op_regions(void);
186 
187 acpi_status
188 acpi_ev_address_space_dispatch(union acpi_operand_object *region_obj,
189 			       union acpi_operand_object *field_obj,
190 			       u32 function,
191 			       u32 region_offset, u32 bit_width, u64 *value);
192 
193 acpi_status
194 acpi_ev_attach_region(union acpi_operand_object *handler_obj,
195 		      union acpi_operand_object *region_obj,
196 		      u8 acpi_ns_is_locked);
197 
198 void
199 acpi_ev_detach_region(union acpi_operand_object *region_obj,
200 		      u8 acpi_ns_is_locked);
201 
202 void
203 acpi_ev_execute_reg_methods(struct acpi_namespace_node *node,
204 			    acpi_adr_space_type space_id, u32 function);
205 
206 acpi_status
207 acpi_ev_execute_reg_method(union acpi_operand_object *region_obj, u32 function);
208 
209 /*
210  * evregini - Region initialization and setup
211  */
212 acpi_status
213 acpi_ev_system_memory_region_setup(acpi_handle handle,
214 				   u32 function,
215 				   void *handler_context,
216 				   void **region_context);
217 
218 acpi_status
219 acpi_ev_io_space_region_setup(acpi_handle handle,
220 			      u32 function,
221 			      void *handler_context, void **region_context);
222 
223 acpi_status
224 acpi_ev_pci_config_region_setup(acpi_handle handle,
225 				u32 function,
226 				void *handler_context, void **region_context);
227 
228 acpi_status
229 acpi_ev_cmos_region_setup(acpi_handle handle,
230 			  u32 function,
231 			  void *handler_context, void **region_context);
232 
233 acpi_status
234 acpi_ev_pci_bar_region_setup(acpi_handle handle,
235 			     u32 function,
236 			     void *handler_context, void **region_context);
237 
238 acpi_status
239 acpi_ev_default_region_setup(acpi_handle handle,
240 			     u32 function,
241 			     void *handler_context, void **region_context);
242 
243 acpi_status
244 acpi_ev_initialize_region(union acpi_operand_object *region_obj,
245 			  u8 acpi_ns_locked);
246 
247 /*
248  * evsci - SCI (System Control Interrupt) handling/dispatch
249  */
250 u32 ACPI_SYSTEM_XFACE acpi_ev_gpe_xrupt_handler(void *context);
251 
252 u32 acpi_ev_sci_dispatch(void);
253 
254 u32 acpi_ev_install_sci_handler(void);
255 
256 acpi_status acpi_ev_remove_all_sci_handlers(void);
257 
258 ACPI_HW_DEPENDENT_RETURN_VOID(void acpi_ev_terminate(void))
259 #endif				/* __ACEVENTS_H__  */
260