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